ShapefileDataSet.Save Methods
Writes an enumeration of features to a new Shapefile on disk.
Overload List
| Name | Description | |
|---|---|---|
 Public method | Save(System.String filename, ShapefileSchema schema, FeatureEnumerator features) | Writes an enumeration of features to a new Shapefile on disk. |
| Public method | Save(System.String filename, ShapefileSchema schema, FeatureCollection features) | Writes a collection of features to a new Shapefile on disk. |
| Public method | Save(System.String filename, ShapefileSchema schema, Crs crs, FeatureEnumerator features) | Writes an enumeration of features to a new Shapefile on disk, with a specified CRS. |
| Public method | Save(System.String filename, ShapefileSchema schema, Crs crs, FeatureCollection features) | Writes a collection of features to a new Shapefile on disk, with a specified CRS. |
| Public method | Save(System.String filename, ShapefileSchema schema, IEnumerable< Feature > features) | Writes a collection of features to a new Shapefile on disk. |
| Public method | Save(System.String filename, ShapefileSchema schema, Crs crs, IEnumerable< Feature > features) | Writes a collection of features to a new Shapefile on disk, with a specified CRS. |
Save(System.String filename, ShapefileSchema schema, FeatureEnumerator features)
Writes an enumeration of features to a new Shapefile on disk.Syntax
public static void Save (
System.String filename,
ShapefileSchema schema,
FeatureEnumerator features
)Parameters
The name of the Shapefile to create, typically with a .shp extension.
The schema to use, specifying how attributes are written to the Shapefile.
The features to write.
Remarks
Use this method to write an enumeration of features to new Shapefile.
Four or five different files will be created:
The main file, typically with a .shp extension, containing the feature geometries.
A corresponding index file with a .shx extension.
A .dbf file containing the feature attributes.
A .cpg file giving the code page for the character encoding.
A .prj file giving the coordinate reference system in well-known text format. This will be written if at least one feature is saved and its coordinate reference system can be represented in the well-known text format.
The files will be overwritten if they exist.
The schema is used to specify which attributes that are written, which type they have and the default value to write if a feature is missing an attribute.
The schema also defines which type of geometry type to write: all objects in a Shapefile must have the same type of geometry. Features of different geometry types will be skipped.
All features must also have the same coordinate reference system (CRS). An exception will be thrown if some feature has a CRS that is different from that of the first feature.
Only the x and y coordinates will be written, the z-coordinates will be discarded.
File size limits
The files for Shapefile data have size limits: according to Esri, both the .shp file and the .dbf file are limited to 2 GB. These limits are not forced by the formats, though: a .dbf file can be much larger, and the .shp format specification would allow files up to 4 GB, or up to 8 GB with a modest reinterpretation (using unsigned integers instead of signed ones for offsets and file size). So, some GIS system can handle huge .dbf files as well as .shp files up to 4 or 8 GB, but for best interoperability, one should avoid creating files larger than 2 GB.
The Save method will throw an exception if the .shp file or the .dbf file would become larger than 2 GB. The more basic class ShapefileWriter allows a different behavior, where the written features are automatically split into multiple files to avoid files larger than 2 GB.
Example
// Save features in a MemoryDataSet to a Shapefile on disk
static void SaveFeaturesToShape(string filename, MemoryDataSet ds)
{
// Create schema for writing point features, with attributes
// IntAttr and StrAttr
ShapefileSchema schema = new ShapefileSchema(GeometryType.Point);
schema.Attributes.Add(new ShapefileAttribute("IntAttr", 0, 10));
schema.Attributes.Add(new ShapefileAttribute("StrAttr", "", 10));
// Save the features from the MemoryDataSet to a new shapefile
ShapefileDataSet.Save(filename, schema, ds.GetFeatures());
}
Save(System.String filename, ShapefileSchema schema, FeatureCollection features)
Writes a collection of features to a new Shapefile on disk.Syntax
public static void Save (
System.String filename,
ShapefileSchema schema,
FeatureCollection features
)Parameters
The name of the Shapefile to create, typically with a .shp extension.
The schema to use, specifying how attributes are written to the Shapefile.
The features to write.
Remarks
Use this method to write a collection of features to new Shapefile.
Four or five different files will be created:
The main file, typically with a .shp extension, containing the feature geometries.
A corresponding index file with a .shx extension.
A .dbf file containing the feature attributes.
A .cpg file giving the code page for the character encoding.
A .prj file giving the coordinate reference system in well-known text format. This will be written if at least one feature is saved and its coordinate reference system can be represented in the well-known text format.
The files will be overwritten if they exist.
The schema is used to specify which attributes that are written, which type they have and the default value to write if a feature is missing an attribute.
The schema also defines which type of geometry type to write: all objects in a Shapefile must have the same type of geometry. Features of different geometry types will be skipped.
All features must also have the same coordinate reference system (CRS). An exception will be thrown if some feature has a CRS that is different from that of the first feature.
Only the x and y coordinates will be written, the z-coordinates will be discarded.
File size limits
The files for Shapefile data have size limits: according to Esri, both the .shp file and the .dbf file are limited to 2 GB. These limits are not forced by the formats, though: a .dbf file can be much larger, and the .shp format specification would allow files up to 4 GB, or up to 8 GB with a modest reinterpretation (using unsigned integers instead of signed ones for offsets and file size). So, some GIS system can handle huge .dbf files as well as .shp files up to 4 or 8 GB, but for best interoperability, one should avoid creating files larger than 2 GB.
The Save method will throw an exception if the .shp file or the .dbf file would become larger than 2 GB. The more basic class ShapefileWriter allows a different behavior, where the written features are automatically split into multiple files to avoid files larger than 2 GB.
Example
// Save features in a MemoryDataSet to a Shapefile on disk
static void SaveFeaturesToShape(string filename, MemoryDataSet ds)
{
// Create schema for writing point features, with attributes
// IntAttr and StrAttr
ShapefileSchema schema = new ShapefileSchema(GeometryType.Point);
schema.Attributes.Add(new ShapefileAttribute("IntAttr", 0, 10));
schema.Attributes.Add(new ShapefileAttribute("StrAttr", "", 10));
// Save the features from the MemoryDataSet to a new shapefile
ShapefileDataSet.Save(filename, schema, ds.GetFeatures());
}
Save(System.String filename, ShapefileSchema schema, Crs crs, FeatureEnumerator features)
Writes an enumeration of features to a new Shapefile on disk, with a specified CRS.Syntax
public static void Save (
System.String filename,
ShapefileSchema schema,
Crs crs,
FeatureEnumerator features
)Parameters
The name of the Shapefile to create, typically with a .shp extension.
The schema to use, specifying how attributes are written to the Shapefile.
The coordinate reference system to save.
The features to write.
Remarks
Use this method to write an enumeration of features to new Shapefile.
This method works like the first Save overload except that a .prj file that contains crs in well-known text format is written even if features is empty. An exception will be thrown if some feature has a different CRS.
Save(System.String filename, ShapefileSchema schema, Crs crs, FeatureCollection features)
Writes a collection of features to a new Shapefile on disk, with a specified CRS.Syntax
public static void Save (
System.String filename,
ShapefileSchema schema,
Crs crs,
FeatureCollection features
)Parameters
The name of the Shapefile to create, typically with a .shp extension.
The schema to use, specifying how attributes are written to the Shapefile.
The coordinate reference system to save.
The features to write.
Remarks
Use this method to write a collection of features to new Shapefile.
This method works like the Save overload except that a .prj file that contains crs in well-known text format is written even if features is empty. An exception will be thrown if some feature has a different CRS.
Save(System.String filename, ShapefileSchema schema, IEnumerable< Feature > features)
Writes a collection of features to a new Shapefile on disk.Syntax
public static void Save (
System.String filename,
ShapefileSchema schema,
IEnumerable< Feature > features
)Parameters
The name of the Shapefile to create, typically with a .shp extension.
The schema to use, specifying how attributes are written to the Shapefile.
The features to write.
Remarks
This method works like Save except that it saves the features read from the enumerator one by one which can take up a less memory when the enumerator creates features lazily.
Example
// Save features in a MemoryDataSet to a Shapefile on disk
static void SaveFeaturesToShape(string filename, MemoryDataSet ds)
{
// Create schema for writing point features, with attributes
// IntAttr and StrAttr
ShapefileSchema schema = new ShapefileSchema(GeometryType.Point);
schema.Attributes.Add(new ShapefileAttribute("IntAttr", 0, 10));
schema.Attributes.Add(new ShapefileAttribute("StrAttr", "", 10));
// Save the features from the MemoryDataSet to a new shapefile
ShapefileDataSet.Save(filename, schema, ds.GetFeatures());
}
Save(System.String filename, ShapefileSchema schema, Crs crs, IEnumerable< Feature > features)
Writes a collection of features to a new Shapefile on disk, with a specified CRS.Syntax
public static void Save (
System.String filename,
ShapefileSchema schema,
Crs crs,
IEnumerable< Feature > features
)Parameters
The name of the Shapefile to create, typically with a .shp extension.
The schema to use, specifying how attributes are written to the Shapefile.
The coordinate reference system to save.
The features to write.
Remarks
This method works like Save except that it saves the features read from the enumerator one by one which can take up a less memory when the enumerator creates features lazily.
Platforms
Windows, Linux, Android