====== ThinkGeo.MapSuite.Core.GeoDbf ====== {{section>upgrade_map_suite_to_10.0}} Class GeoDbf. ===== Inheritance Hierarchy ===== *System.Object ***ThinkGeo.MapSuite.Core.GeoDbf** ===== Members Summary ===== ==== Public Constructors ==== ** {{wiki:PublicMethod.gif|}} GeoDbf() ** * //Initializes a new instance of the class.// == Remarks == * //N/A// == Parameters ==
** {{wiki:PublicMethod.gif|}} GeoDbf(String) ** * //Initializes a new instance of the class.// == Remarks == * //N/A// == Parameters == * //pathFileName// * Type:String * Description:Name of the path file.
** {{wiki:PublicMethod.gif|}} GeoDbf(String,DbfReadWriteMode) ** * //Initializes a new instance of the class.// == Remarks == * //N/A// == Parameters == * //pathFileName// * Type:String * Description:Name of the path file. * //readWriteMode// * Type:[[ThinkGeo.MapSuite.Core.DbfReadWriteMode|DbfReadWriteMode]] * Description:The read write mode.
** {{wiki:PublicMethod.gif|}} GeoDbf(String,DbfReadWriteMode,Encoding) ** * //Initializes a new instance of the class.// == Remarks == * //N/A// == Parameters == * //pathFileName// * Type:String * Description:Name of the path file. * //readWriteMode// * Type:[[ThinkGeo.MapSuite.Core.DbfReadWriteMode|DbfReadWriteMode]] * Description:The read write mode. * //encoding// * Type:Encoding * Description:The encoding.
** {{wiki:PublicMethod.gif|}} GeoDbf(String,DbfReadWriteMode,Encoding,CultureInfo) ** * //Initializes a new instance of the class.// == Remarks == * //N/A// == Parameters == * //pathFileName// * Type:String * Description:Name of the path file. * //readWriteMode// * Type:[[ThinkGeo.MapSuite.Core.DbfReadWriteMode|DbfReadWriteMode]] * Description:The read write mode. * //encoding// * Type:Encoding * Description:The encoding. * //cultureInfo// * Type:CultureInfo * Description:The culture information.
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} Dispose() ** * //Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetColumn(String) ** * //Gets the column.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.DbfColumn|DbfColumn]] * Description:DbfColumn. == Parameters == * //columnName// * Type:String * Description:Name of the column.
** {{wiki:PublicMethod.gif|}} GetColumn(Int32) ** * //Gets the column.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.DbfColumn|DbfColumn]] * Description:DbfColumn. == Parameters == * //columnNumber// * Type:Int32 * Description:The column number.
** {{wiki:PublicMethod.gif|}} ReadRecord(Int32) ** * //Reads the record.// == Remarks == * //N/A// == Return Value == * Type:Dictionary * Description:Dictionary. == Parameters == * //recordNumber// * Type:Int32 * Description:The record number.
** {{wiki:PublicMethod.gif|}} ReadFieldAsBoolean(Int32,Int32) ** * //Reads the field as boolean.// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:Boolean. == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnNumber// * Type:Int32 * Description:The column number.
** {{wiki:PublicMethod.gif|}} ReadFieldAsBoolean(Int32,String) ** * //Reads the field as boolean.// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:Boolean. == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnName// * Type:String * Description:Name of the column.
** {{wiki:PublicMethod.gif|}} ReadFieldAsDateTime(Int32,String) ** * //Reads the field as date time.// == Remarks == * //N/A// == Return Value == * Type:DateTime * Description:DateTime. == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnName// * Type:String * Description:Name of the column.
** {{wiki:PublicMethod.gif|}} ReadFieldAsDateTime(Int32,Int32) ** * //Reads the field as date time.// == Remarks == * //N/A// == Return Value == * Type:DateTime * Description:DateTime. == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnNumber// * Type:Int32 * Description:The column number.
** {{wiki:PublicMethod.gif|}} ReadFieldAsDouble(Int32,String) ** * //Reads the field as double.// == Remarks == * //N/A// == Return Value == * Type:Double * Description:Double. == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnName// * Type:String * Description:Name of the column.
** {{wiki:PublicMethod.gif|}} ReadFieldAsDouble(Int32,Int32) ** * //Reads the field as double.// == Remarks == * //N/A// == Return Value == * Type:Double * Description:Double. == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnNumber// * Type:Int32 * Description:The column number.
** {{wiki:PublicMethod.gif|}} ReadFieldAsInteger(Int32,Int32) ** * //Reads the field as integer.// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:System.Int32. == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnNumber// * Type:Int32 * Description:The column number.
** {{wiki:PublicMethod.gif|}} ReadFieldAsInteger(Int32,String) ** * //Reads the field as integer.// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:System.Int32. == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnName// * Type:String * Description:Name of the column.
** {{wiki:PublicMethod.gif|}} ReadFieldAsString(Int32,String) ** * //Reads the field as string.// == Remarks == * //N/A// == Return Value == * Type:String * Description:System.String. == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnName// * Type:String * Description:Name of the column.
** {{wiki:PublicMethod.gif|}} ReadFieldAsString(Int32,Int32) ** * //Reads the field as string.// == Remarks == * //N/A// == Return Value == * Type:String * Description:System.String. == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnNumber// * Type:Int32 * Description:The column number.
** {{wiki:PublicMethod.gif|}} WriteField(Int32,String,Double) ** * //Writes the field.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnName// * Type:String * Description:Name of the column. * //value// * Type:Double * Description:The value.
** {{wiki:PublicMethod.gif|}} WriteField(Int32,Int32,Int32) ** * //Writes the field.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnNumber// * Type:Int32 * Description:The column number. * //value// * Type:Int32 * Description:The value.
** {{wiki:PublicMethod.gif|}} WriteField(Int32,String,Boolean) ** * //Writes the field.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnName// * Type:String * Description:Name of the column. * //value// * Type:Boolean * Description:The value.
** {{wiki:PublicMethod.gif|}} WriteField(Int32,Int32,Double) ** * //Writes the field.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnNumber// * Type:Int32 * Description:The column number. * //value// * Type:Double * Description:The value.
** {{wiki:PublicMethod.gif|}} WriteField(Int32,String,Int32) ** * //Writes the field.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnName// * Type:String * Description:Name of the column. * //value// * Type:Int32 * Description:The value.
** {{wiki:PublicMethod.gif|}} WriteField(Int32,Int32,String) ** * //Writes the field.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnNumber// * Type:Int32 * Description:The column number. * //value// * Type:String * Description:The value.
** {{wiki:PublicMethod.gif|}} WriteField(Int32,String,String) ** * //Writes the field.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnName// * Type:String * Description:Name of the column. * //value// * Type:String * Description:The value.
** {{wiki:PublicMethod.gif|}} WriteField(Int32,Int32,Boolean) ** * //Writes the field.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnNumber// * Type:Int32 * Description:The column number. * //value// * Type:Boolean * Description:The value.
** {{wiki:PublicMethod.gif|}} WriteField(Int32,Int32,DateTime) ** * //Writes the field.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnNumber// * Type:Int32 * Description:The column number. * //value// * Type:DateTime * Description:The value.
** {{wiki:PublicMethod.gif|}} WriteField(Int32,String,DateTime) ** * //Writes the field.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //columnName// * Type:String * Description:Name of the column. * //value// * Type:DateTime * Description:The value.
** {{wiki:PublicMethod.gif|}} Open() ** * //Opens this instance.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Close() ** * //Closes this instance.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Flush() ** * //Flushes this instance.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Pack() ** * //Packs this instance.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetColumnNumber(String) ** * //Gets the column number.// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:System.Int32. == Parameters == * //columnName// * Type:String * Description:Name of the column.
** {{wiki:PublicMethod.gif|}} GetColumnName(Int32) ** * //Gets the name of the column.// == Remarks == * //N/A// == Return Value == * Type:String * Description:System.String. == Parameters == * //columnNumber// * Type:Int32 * Description:The column number.
** {{wiki:PublicMethod.gif|}} DeleteRecord(Int32) ** * //Deletes the record.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //recordNumber// * Type:Int32 * Description:The record number.
** {{wiki:PublicMethod.gif|}} UpdateColumnName(Int32,String) ** * //Updates the name of the column.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //columnNumber// * Type:Int32 * Description:The column number. * //newColumnName// * Type:String * Description:New name of the column.
** {{wiki:PublicMethod.gif|}} UndeleteRecord(Int32) ** * //Undeletes the record.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //recordNumber// * Type:Int32 * Description:The record number.
** {{wiki:PublicMethod.gif|}} IsRecordDeleted(Int32) ** * //Determines whether [is record deleted] [the specified record number].// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:true if [is record deleted] [the specified record number]; otherwise, false. == Parameters == * //recordNumber// * Type:Int32 * Description:The record number.
** {{wiki:PublicMethod.gif|}} AddEmptyRecord() ** * //Adds the empty record.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} ReadRecordAsString(Int32) ** * //Reads the record as string.// == Remarks == * //N/A// == Return Value == * Type:Dictionary * Description:Dictionary. == Parameters == * //recordNumber// * Type:Int32 * Description:The record number.
** {{wiki:PublicMethod.gif|}} WriteRecord(Int32,IEnumerable) ** * //Writes the record.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //recordNumber// * Type:Int32 * Description:The record number. * //values// * Type:IEnumerable * Description:The values.
** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Type * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetValidColumns(IEnumerable) ** * //Gets the valid columns.// == Remarks == * //N/A// == Return Value == * Type:Collection<[[ThinkGeo.MapSuite.Core.DbfColumn|DbfColumn]]> * Description:Collection. == Parameters == * //columns// * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.DbfColumn|DbfColumn]]> * Description:The columns.
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetValidColumns(IEnumerable,Encoding) ** * //Gets the valid columns.// == Remarks == * //N/A// == Return Value == * Type:Collection<[[ThinkGeo.MapSuite.Core.DbfColumn|DbfColumn]]> * Description:Collection. == Parameters == * //columns// * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.DbfColumn|DbfColumn]]> * Description:The columns. * //encoding// * Type:Encoding * Description:The encoding.
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetValidColumnNames(IEnumerable) ** * //Gets the valid column names.// == Remarks == * //N/A// == Return Value == * Type:Collection * Description:Collection. == Parameters == * //columnNames// * Type:IEnumerable * Description:The column names.
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetValidColumnNames(IEnumerable,Encoding) ** * //Gets the valid column names.// == Remarks == * //N/A// == Return Value == * Type:Collection * Description:Collection. == Parameters == * //columnNames// * Type:IEnumerable * Description:The column names. * //encoding// * Type:Encoding * Description:The encoding.
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CopyDbfHeader(String,String) ** * //Copies the DBF header.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //sourcePathFileName// * Type:String * Description:Name of the source path file. * //destinationPathFileName// * Type:String * Description:Name of the destination path file.
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CopyDbfHeader(String,String,OverwriteMode) ** * //Copies the DBF header.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //sourcePathFileName// * Type:String * Description:Name of the source path file. * //destinationPathFileName// * Type:String * Description:Name of the destination path file. * //overwriteMode// * Type:[[ThinkGeo.MapSuite.Core.OverwriteMode|OverwriteMode]] * Description:The overwrite mode.
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CreateDbfFile(String,IEnumerable) ** * //Creates the DBF file.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //dbfPathFileName// * Type:String * Description:Name of the DBF path file. * //dbfColumns// * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.DbfColumn|DbfColumn]]> * Description:The DBF columns.
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CreateDbfFile(String,IEnumerable,OverwriteMode) ** * //Creates the DBF file.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //dbfPathFileName// * Type:String * Description:Name of the DBF path file. * //dbfColumns// * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.DbfColumn|DbfColumn]]> * Description:The DBF columns. * //overwriteMode// * Type:[[ThinkGeo.MapSuite.Core.OverwriteMode|OverwriteMode]] * Description:The overwrite mode.
** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} CreateDbfFile(String,IEnumerable,OverwriteMode,Encoding) ** * //Creates the DBF file.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //dbfPathFileName// * Type:String * Description:Name of the DBF path file. * //dbfColumns// * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.DbfColumn|DbfColumn]]> * Description:The DBF columns. * //overwriteMode// * Type:[[ThinkGeo.MapSuite.Core.OverwriteMode|OverwriteMode]] * Description:The overwrite mode. * //encoding// * Type:Encoding * Description:The encoding.
==== Protected Methods ==== ** {{wiki:ProtectedMethod.gif|}} Open(GeoFileMode,GeoFileAccess) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //fileMode// * Type:[[ThinkGeo.MapSuite.Core.GeoFileMode|GeoFileMode]] * Description:N/A * //fileAccess// * Type:[[ThinkGeo.MapSuite.Core.GeoFileAccess|GeoFileAccess]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} AddStringField(String,Int32) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //columnName// * Type:String * Description:N/A * //length// * Type:Int32 * Description:N/A
** {{wiki:ProtectedMethod.gif|}} AddIntField(String,Int32) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //columnName// * Type:String * Description:N/A * //length// * Type:Int32 * Description:N/A
** {{wiki:ProtectedMethod.gif|}} AddDoubleColumn(String,Int32,Int32) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //columnName// * Type:String * Description:N/A * //length// * Type:Int32 * Description:N/A * //decimalLength// * Type:Int32 * Description:N/A
** {{wiki:ProtectedMethod.gif|}} AddBoolColumn(String) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //columnName// * Type:String * Description:N/A
** {{wiki:ProtectedMethod.gif|}} AddMemoField(String,Int32) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //columnName// * Type:String * Description:N/A * //length// * Type:Int32 * Description:N/A
** {{wiki:ProtectedMethod.gif|}} AddDateField(String) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //columnName// * Type:String * Description:N/A
** {{wiki:ProtectedMethod.gif|}} AddDateTimeField(String) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //columnName// * Type:String * Description:N/A
** {{wiki:ProtectedMethod.gif|}} ChangeDBCFileName(String) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //newDBCFileNmae// * Type:String * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnStreamLoading(StreamLoadingEventArgs) ** * //Handles the event.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] * Description:The instance containing the event data.
** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Object * Description:N/A == Parameters ==
==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} IsOpen ** * //Gets a value indicating whether this instance is open.// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} ColumnCount ** * //Gets the column count.// == Remarks == * //N/A// == Return Value == * Type:Int32 ** {{wiki:PublicProperty.gif|}} RecordCount ** * //Gets the record count.// == Remarks == * //N/A// == Return Value == * Type:Int32 ** {{wiki:PublicProperty.gif|}} PathFileName ** * //Gets or sets the name of the path file.// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} ReadWriteMode ** * //Gets or sets the read write mode.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Core.DbfReadWriteMode|DbfReadWriteMode]] ** {{wiki:PublicProperty.gif|}} Encoding ** * //Gets or sets the encoding.// == Remarks == * //N/A// == Return Value == * Type:Encoding ** {{wiki:PublicProperty.gif|}} CultureInfo ** * //Gets or sets the culture information.// == Remarks == * //N/A// == Return Value == * Type:CultureInfo ==== Protected Properties ==== ==== Public Events ==== ** {{wiki:PublicEvent.gif|}} StreamLoading ** * //Occurs when [stream loading].// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]]