Class ObjectClassClass

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("AF10D71A-A61B-11D4-A64C-0008C711C8C1")]
public class ObjectClassClass : ObjectClass, IDataset, IDatasetEdit, IDatasetEditInfo, IDatasetAnalyze, ISchemaLock, ITable, IObjectClass, IClass, IClassSchemaEdit4, IClassSchemaEdit3, IClassSchemaEdit2, IClassSchemaEdit, IClassSchemaEditEx, IModelInfo, ISubtypes, IValidation2, IValidation, IObjectClassInfo, IObjectClassInfo2, ITableCapabilities
Inheritance
ObjectClassClass
Implements
Inherited Members

Explicit Interface Implementations

AddField(IField)

Adds a field to this object class.

virtual void AddField(IField Field)

Parameters

Field IField

Remarks

Prior to adding a new field to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

Attempting to add a new field that does not allow null values will fail, if the class already has data in it. The only solution is to recreate the class with the non-nullable field, then copy the rows from the original class into the new class.

AddGlobalID(string)

Adds a global ID column to a class and populates it with GUIDs.

virtual void AddGlobalID(string FieldName)

Parameters

FieldName string

Remarks

Adds a column of type GlobalID to a Geodatabase table or feature class.

GlobalID columns can be added or deleted to versioned as well as non-versioned ArcSDE tables. In ArcSDE, GlobalID columns can be added to tables that already have data. With Personal or File Geodatabases, however, the tables must have no rows otherwise an error is generated when trying to add the column.

Attempts to add these columns for non-supported data sources like shapefile and coverages fail with errors.

AddIndex(IIndex)

Adds an index to this object class.

virtual void AddIndex(IIndex Index)

Parameters

Index IIndex

Remarks

Prior to adding a new index to a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

AddRule(IRule)

Adds the rule to the set of associated rules.

virtual void AddRule(IRule Rule)

Parameters

Rule IRule

AddSubtype(int, string)

Adds the subtype to the set of associated subtypes.

virtual void AddSubtype(int SubtypeCode, string SubtypeName)

Parameters

SubtypeCode int
SubtypeName string

Remarks

AddSubtype will create a new subtype for the associated object class. This method requires a subtype code as a Long and a subtype name as a String. Before adding subtypes, use the ISubtypes::SubtypeFieldName property to set the subtypes field.

Once created, you can use the ISubtypes::DefaultValue property to set default values for this subtypes fields, and the ISubtypes::Domain property to assign domains to fields for the subtype.

AliasName

The alias name of the object class.

virtual string AliasName { get; }

Returns

string

Remarks

Object classes in a geodatabase can have between one and three names. The name of the object class, which is the same as the name of the table in the DBMS in which the objects in the object class are stored, the alias name which the user can set for display purposes in end user applications. The third name is the model name which is a tool for developers of custom objects to use to guarantee the names of objects independent of the true name or alias name.

The AliasName property returns the alias name for the object class. If the object class has no alias name, then AliasName will return the name of the object class (fully qualified if on ArcSDE). The alias name can be modified using the IClassSchemEdit interface.

AllowableComponents

The allowable components to be analyzed.

virtual int AllowableComponents { get; }

Returns

int

Remarks

The AllowableComponents property indicates which parts of the table or feature class can be analyzed. The returned value is based on the esriTableComponents enumeration. Members from this enumeration can be bitwise or’d together.

AlterAliasName(string)

The alias name of the object class.

virtual void AlterAliasName(string Name)

Parameters

Name string

Remarks

Object classes in a Geodatabase can have between one and three names. The name of the object class, which is the same as the name of the table in the DBMS in which the objects in the object class are stored, the alias name which the user can set for display purposes in end user applications. The third name is the model name which is a tool for developers of custom objects to use to guarantee the names of objects independent of the true name or alias name.

The AlterAliasName method sets the alias name for the object class. The alias name can be returned using the IObjectClass interface.

AlterClassExtensionCLSID(UID, IPropertySet)

Changes the class extension COM class associated with this database class.

virtual void AlterClassExtensionCLSID(UID ClassExtensionCLSID, IPropertySet classExtensionProperties)

Parameters

ClassExtensionCLSID UID
classExtensionProperties IPropertySet

Remarks

AlterClassExtensionCLSID will try to instantiate the object for the class extension that you provide. If it fails to instantiate it, the method will fail. Therefore, you must have the DLL which has the implementation of your class extension registered on your system before you call AlterClassExtensionCLSID.

Before you QI for AlterClassExtensionCLSID, you will have had to open the object class. So, if this fails because you no longer have the DLL registered on your system for a class extension that is already associated with the class, then you must use the IFeatureWorkspaceSchemaEdit interface to alter the class extension CLSID.

AlterClassExtensionProperties(IPropertySet)

Changes the class extension properties associated with this object class.

virtual void AlterClassExtensionProperties(IPropertySet classExtensionProperties)

Parameters

classExtensionProperties IPropertySet

Remarks

AlterClassExtensionProperties takes as an argument the new properties for the class extension as an IPropertySet.

AlterDefaultValue(string, object)

The default value of the object class field.

virtual void AlterDefaultValue(string FieldName, object Value)

Parameters

FieldName string
Value object

Remarks

You can assign a default value to a field in an object class at either the class level, or the subtype level. The AlterDefaultValue method on IClassSchemaEdit allows you to set a default value for a field at the class level.

AlterDefaultValue takes as arguments the name of the field you want to associate a default value with as a string, and the default value you are associating as a variant. AlterDefaultValue will fail if the default value cannot be stored in the field.

Once a default value is associated with a field in your object class, you can use the InitDefaultValues method on IRowSubtypes to populate the fields in a object in your object class with its default value. This method is most often called after you have created a new feature or object in the object class, and before storing it.

AlterDomain(string, IDomain)

The default domain of the object class field.

virtual void AlterDomain(string FieldName, IDomain Domain)

Parameters

FieldName string
Domain IDomain

Remarks

Domains are used in the Geodatabase to validate the contents of fields in an object class. For example, you can use a domain to specify a valid range of values, or a valid set of values for a particular field in an object class. You can assign domains to a field in an object class at either the class level, or the subtype level. The AlterDomain method on IClassSchemaEdit allows you to set a domain for a field at the class level.

AlterDomain takes as arguments the name of the field you want to associate a domain with as a string, and the domain you are associating as an IDomain. You can get an enumeration of domains in a workspace by calling the Domains or DomainsByFieldType methods on the IWorkspaceDomains interface.

Once a domain is associated with a field in your object class, the values in that field will be validated against that domain when a row in the object class is validated with the IValidate interface, or the Validate Selection command in the Editor.

AlterFieldAliasName(string, string)

The alias name of the object class field.

virtual void AlterFieldAliasName(string FieldName, string AliasName)

Parameters

FieldName string
AliasName string

Remarks

Fields in object classes in a Geodatabase can have between one and three names. The name of the field, which is the same as the name of the field in the table in the DBMS in which the objects in the object class are stored, the alias name which the user can set for display purposes in end user applications. The third name is the model name which is a tool for developers of custom objects to use to guarantee the names of fields independent of the true name or alias name.

The AlterFieldAliasName method sets the alias name for a field in the object class. The alias name can be returned using the IField interface.

AlterFieldModelName(string, string)

The model name of the object class field.

virtual void AlterFieldModelName(string FieldName, string ModelName)

Parameters

FieldName string
ModelName string

Remarks

Fields in object classes in a Geodatabase can have between one and three names. The name of the field, which is the same as the name of the field in the table in the DBMS in which the objects in the object class are stored, the alias name which the user can set for display purposes in end user applications. The third name is the model name which is a tool for developers of custom objects to use to guarantee the names of fields independent of the true name or alias name.

The AlterFieldModelName method sets the model name for a field in the object class. The model name can be returned using the IModelInfo interface.

AlterFieldName(string, string)

Alter the name of the object class field.

virtual void AlterFieldName(string FieldName, string newFieldName)

Parameters

FieldName string
newFieldName string

AlterInstanceCLSID(UID)

Changes the instance COM class associated with this database class.

virtual void AlterInstanceCLSID(UID InstanceCLSID)

Parameters

InstanceCLSID UID

Remarks

AlterInstanceCLSID will try to instantiate the object for the CLSID that you provide. If it fails to instantiate it, the method will fail. Therefore, you must have the DLL which has the implementation of your custom object registered on your system before you call AlterInstanceCLSID.

Before you QI for AlterInstanceCLSID, you will have had to open the object class. So, if this fails because you no longer have the DLL registered on your system, then you must use the IFeatureWorkspaceSchemaEdit interface to alter the instance CLSID.

No additional checking is done beyond instantiating the instance object. If the object class does not have the fields required for supporting the custom object then your class may not function with its new instance CLSID.

AlterModelName(string)

The model name of the object class.

virtual void AlterModelName(string Name)

Parameters

Name string

Remarks

Object classes in a Geodatabase can have between one and three names. The name of the object class, which is the same as the name of the table in the DBMS in which the objects in the object class are stored, the alias name which the user can set for display purposes in end user applications. The third name is the model name which is a tool for developers of custom objects to use to guarantee the names of objects independent of the true name or alias name.

The AlterModelName method sets the model name for the object class. The model name can be returned using the IModelInfo interface.

AlterRule(IRule)

Alter the existing validation rule.

virtual void AlterRule(IRule Rule)

Parameters

Rule IRule

Remarks

The AlterRule method is used to change the characteristics of an existing rule.  This is currently implemented to change a subset of properties for connectivity rules only.  These properties are:

  • minimum and maximum cardinalities
  • default junction for junction connectivity rules
  • default junction classID for edge connectivity rules
  • default junction subtype code for edge connectivity rules

To alter other properties of a connectivity rule, the rule must be deleted and recreated with the appropriate changes.

Analyze(int)

Analyze the data to update/generate DBMS statistics.

virtual void Analyze(int tableComponents)

Parameters

tableComponents int

Remarks

When applied to a feature dataset, Analyze updates the statistics for all of the tables.

BrowseName

The browse name of the dataset.

virtual string BrowseName { get; set; }

Returns

string

Remarks

BrowseName returns file names without their extension. For example, States.shp would appear as States.

CLSID

The GUID for the COM Class (CoClass) corresponding to instances of this object class.

virtual UID CLSID { get; }

Returns

UID

CanBypassEditSession()

Indicates if updates to objects can be safely made outside of an edit session.

virtual bool CanBypassEditSession()

Returns

bool

Remarks

CanBypassEditSession is a convenience method that returns True if the instances of this object class may be created or updated outside of a Geodatabase edit session (an edit session is started by using the StartEditing method on the IWorkspaceEdit or the StartMultiuserEditing method on the IMultiuserWorkspaceEdit interface).

If True , then applications may update the data in this object class using any of the data updating interfaces and methods described here without starting an edit session. In this case applications are responsible for starting host database transactions as appropriate and for discarding cached object states across transaction boundaries when running on an ArcSDE database.

If False, then applications should always make modifications to the data in this object class within an edit session for correct multi-user behavior and for correct management of database state internally cached by the Geodatabase for the objects in this object class.

This method returns False for network feature classes. By default, this method returns True for non-network custom object classes. The developer of a non-network custom object class can change this behavior by implementing this interface on the class extension associated with the class and returning true for the method.

CanBypassStoreMethod()

Indicates if updates to objects can bypass the Store method and OnChange notifications for efficiency.

virtual bool CanBypassStoreMethod()

Returns

bool

Remarks

CanBypassStoreMethod is a convenience method that returns True if the instances of this object class have no custom behavior associated with creating or updating objects and if the object class does not participate in composite relationship classes or in relationship classes that require object notification. A return value of True implies that insert cursors handed out by the geodatabase will internally bypass the CreateRow and Store mechanisms when creating objects. A return value of False indicates that insert cursors will not bypass custom Store or OnChanged behavior implemented by the custom row object for this class.

By default, this method returns False for custom object classes. The developer of a custom object class can change this behavior by implementing this interface on the class extension associated with the class and returning True for the method.

In addition, a developer can implement this interface on the class extension of a simple class and set this property to False . Doing this will ensure that when features in the class are inserted, updated or deleted by editor tools that use insert and update cursors, such as Planarize, Create Features and the Object Loader do not bypass Store or OnChanged behavior. By default, this property for a simple class is logically True, meaning these tools will not broacast Geodatabase events which in turn are not rebroadcast as editor events (for which a custom editor application may be listening). Set this to False for those classes for which you always want to have these events broadcast. Alternatively, this can be set globally for the entire edit session using the IWorkspaceEditControl interface.

CanCopy()

True if this dataset can be copied.

virtual bool CanCopy()

Returns

bool

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods.  For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class.  To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

The CanCopy method is supported by:

  • CAD Drawings
  • Coverages
  • DBase Tables
  • Info Tables
  • Raster Datasets
  • SDC datasets
  • SDC Network Datasets
  • Shapefiles
  • Shapefile Network Datasets

CanDelete()

True if this dataset can be deleted.

virtual bool CanDelete()

Returns

bool

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods.  For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class.  To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

CanEdit

True if the dataset supports edit sessions with the ability to discard edits on save.

virtual bool CanEdit { get; }

Returns

bool

Remarks

This property is to be used within an active edit session, results cannot be guaranteed if called on a dataset outside of an edit session.

CanRedo

True if the dataset supports edit sessions with the ability to redo undone operations.

virtual bool CanRedo { get; }

Returns

bool

CanRename()

True if this dataset can be renamed.

virtual bool CanRename()

Returns

bool

Remarks

The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods.  For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class.  To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.

CanSelect

Indicates if the table supports selection.

virtual bool CanSelect { get; }

Returns

bool

Remarks

Use CanSelect to determine if you can open a selection set on the table. A situation where CanSelect will be False is a standalone database table without an OID column.

CanUndo

True if the dataset supports edit sessions with the ability to undo individual edit operations.

virtual bool CanUndo { get; }

Returns

bool

Category

The category of the dataset.

virtual string Category { get; }

Returns

string

Remarks

IDataset::Category returns a description of the category of the dataset.  The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog.  The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".

The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.

ChangeSchemaLock(esriSchemaLock)

Changes a schema lock.

virtual void ChangeSchemaLock(esriSchemaLock schemaLock)

Parameters

schemaLock esriSchemaLock

Remarks

There are two kinds of schema locks: shared and exclusive. Shared schema locks are applied automatically by the geodatabase when accessing a dataset and are removed when all references to the dataset are removed. For this reason, it's not necessary to explicitly apply or remove shared schema locks. There is no limit to the number of shared schema locks a dataset or object can have at any given time.
In contrast to shared schema locks, exclusive schema locks are controlled by the developer or ArcGIS application, such as ArcMap or ArcCatalog. An exclusive lock is used to lock a geodatabase dataset or object from use by others to make the necessary changes to it. An exclusive lock is promoted from a shared lock and demoted back to a shared lock when no longer needed. The presence of additional shared schema locks on a dataset or object prevents an exclusive schema lock from being applied and precludes the ability to make changes to the underlying dataset and its schema while it is in use. Only one exclusive schema lock is allowed per dataset. As opposed to shared schema locks, exclusive schema locks are not applied or removed automatically; it is the responsibility of the developer to apply or remove exclusive schema locks.
Limit the scope of exclusive schema locks to the operation that requires the lock. Gather the necessary information to perform the action, obtain the exclusive lock, make the change, and release the lock. Some examples of operations for which an exclusive schema lock should be obtained include:
  • Modifications to attribute domains, such as adding or removing values from a coded value domain or changing the range for range domains
  • Adding or deleting a field from a feature class or object class
  • Associating a class extension with a feature class
  • Creating a topology, geometric network, network dataset, terrain, schematic dataset, representation, or cadastral fabric on a set of feature classes
  • Any use of the IClassSchemaEdit interface
  • Putting a feature class into and taking it out of load-only mode with the IFeatureClassLoad.LoadOnlyMode method
  • Managing (creating, deleting, or modifying) spatial and attribute indexes
Once the action requiring an exclusive schema lock is complete, the exclusive schema lock must be demoted to a shared lock. This includes when errors are raised during the schema modification, for example, consider the case where a field is being deleted from a feature class. To delete the field, an exclusive schema lock is obtained. However, on the call to DeleteField, an error is thrown; that is, the field being deleted is a required field, such as the ObjectID field. In the handling of the error, the exclusive schema lock must be demoted to a shared lock before proceeding.
 
 

Copy(string, IWorkspace)

Copies this dataset to a new dataset with the specified name.

virtual IDataset Copy(string copyName, IWorkspace copyWorkspace)

Parameters

copyName string
copyWorkspace IWorkspace

Returns

IDataset

Remarks

IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.

CreateRow()

Creates a row in the database with a system assigned object ID and null property values.

virtual IRow CreateRow()

Returns

IRow

Remarks

The CreateRow method creates a new row in the underlying database with a system assigned object id value. A row object representing the created row is returned to the caller. The row object returned has the system assigned object ID as the value of the OIDField. All other fields are initialized to null values if they can be made null and to built-in default values appropriate to the type of the field if they cannot be made null.

The caller is responsible for setting the desired field values into the row and calling the Store method on the row. If the table represents an object class with subtypes, then it is the caller’s responsibility to set the default subtype code into the row and call the InitDefaultValues method on the row before storing, if that is the desired result. For tables without object behavior, insert cursors offer a more efficient way for inserting new rows.

CreateRowBuffer()

Creates a row buffer that can be used with an insert cursor.

virtual IRowBuffer CreateRowBuffer()

Returns

IRowBuffer

Remarks

The CreateRowBuffer method creates a new row buffer object in memory and returns it to the caller. No row is created in the database. The returned row buffer does not have an object ID value. The caller can set values into the row buffer and use it as an argument to the InsertRow method on an insert cursor; the latter is obtained by calling the Insert method on the Table.

CreatedAtFieldName

Changes the field name for recording the creation time for Editor Tracking on this object class.

virtual string CreatedAtFieldName { set; }

Returns

string

Remarks

Once you set this property, editor tracking is enabled on the dataset. If you later need to stop recording when features or records are created, set the CreatedAtFieldName property to an empty string. To disable editor tracking on the dataset, CreatorFieldName, CreatedAtFieldName, EditorFieldName, and EditedAtFieldName must each be set to an empty string. 

CreatorFieldName

Changes the field name for recording the creator for Editor Tracking on this object class.

virtual string CreatorFieldName { set; }

Returns

string

Remarks

Once you set this property, editor tracking is enabled on the dataset. If you later need to stop recording creator user name information, set the CreatorFieldName property to an empty string. To disable editor tracking on the dataset, CreatorFieldName, CreatedAtFieldName, EditorFieldName, and EditedAtFieldName must each be set to an empty string. 

DefaultSubtypeCode

The default subtype associated with the class.

virtual int DefaultSubtypeCode { get; set; }

Returns

int

Remarks

This property sets or returns the value of the default subtype code for the associated class.

DefaultValue[int, string]

The default value for the associated attribute.

virtual object DefaultValue[int SubtypeCode, string FieldName] { get; set; }

Parameters

SubtypeCode int
FieldName string

Returns

object

Remarks

This property return the default value for a particular field associated with a subtype. It requires the subtype code as a Long and the field name as a String . You can use the IField::Type property to determine the type of field that you are passing into the function so you will know what data type is being returned.

Delete()

Deletes this dataset.

virtual void Delete()

Remarks

Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.

DeleteField(IField)

Deletes a field from this object class.

virtual void DeleteField(IField Field)

Parameters

Field IField

Remarks

DeleteField removes the specified field from a table, object class or feature class. Fields that are required by the Geodatabase and cannot be removed include:

  • OBJECTID field
  • SHAPE and shape dependent fields such as SHAPE_Length
  • Enabled, AncillaryRole and Weight field for network feature classes
  • Subtype fields. In order to delete a subtype field, it must first be removed as the subtype field, see the help on ISubtypes::SubtypeFieldName

Prior to deleting a field from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

DeleteGlobalID()

Deletes the global ID column.

virtual void DeleteGlobalID()

Remarks

Deletes a column of type GlobalID to a Geodatabse Table or FeatureClass.

GlobalID columns can be added or deleted to versioned as well as non-versioned ArcSDE tables. 

DeleteIndex(IIndex)

Deletes an index from this object class.

virtual void DeleteIndex(IIndex Index)

Parameters

Index IIndex

Remarks

Prior to deleting an index from a class, an exclusive schema lock should be obtained using the ISchemaLock interface.

DeleteRule(IRule)

Deletes the rule from the set of associated rules.

virtual void DeleteRule(IRule Rule)

Parameters

Rule IRule

DeleteSearchedRows(IQueryFilter)

Delete the Rows in the database selected by the specified query.

virtual void DeleteSearchedRows(IQueryFilter QueryFilter)

Parameters

QueryFilter IQueryFilter

DeleteSubtype(int)

Deletes the subtype from the set of associated subtypes.

virtual void DeleteSubtype(int SubtypeCode)

Parameters

SubtypeCode int

Remarks

DeleteSubtype will delete a subtype for the associated object class. Calling DeleteSubtype will also remove any reference to that subtype in the geodatabase.

Domain[int, string]

The domain given the subtype and field.

virtual IDomain Domain[int SubtypeCode, string FieldName] { get; set; }

Parameters

SubtypeCode int
FieldName string

Returns

IDomain

Remarks

This property returns or sets an IDomain object associated with a particular subtype code and field. The subtype code is required as a Long and field name as a String.

EXTCLSID

The GUID for the COM Class (CoClass) corresponding to the class extension for this object class.

virtual UID EXTCLSID { get; }

Returns

UID

EditedAtFieldName

Changes the field name for recording the edit time for Editor Tracking on this object class.

virtual string EditedAtFieldName { set; }

Returns

string

Remarks

Once you set this property, editor tracking is enabled on the dataset. If you later need to stop recording last edited date information, set the EditedAtFieldName property to an empty string. To disable editor tracking on the dataset, CreatorFieldName, CreatedAtFieldName, EditorFieldName, and EditedAtFieldName must each be set to an empty string. 

EditorFieldName

Changes the field name for recording the editor for Editor Tracking on this object class.

virtual string EditorFieldName { set; }

Returns

string

Remarks

Once you set this property, editor tracking is enabled on the dataset. If you later need to stop recording editor user name information, set the EditorFieldName property to an empty string. To disable editor tracking on the dataset, CreatorFieldName, CreatedAtFieldName, EditorFieldName, and EditedAtFieldName must each be set to an empty string. 

Extension

The extension for this object class.

virtual object Extension { get; }

Returns

object

ExtensionProperties

The extension properties for this object class.

virtual IPropertySet ExtensionProperties { get; }

Returns

IPropertySet

Fields

The fields collection for this object class.

virtual IFields Fields { get; }

Returns

IFields

Remarks

<P>Each table in a database has an ordered collection of fields, there is always at least one field in a table. The ordered collection behaves like a list, so it is possible to access individual fields by a numbered position (or index) in the list.</P> <P>A <STRONG>Fields </STRONG>collection can also exist independently of a table, for example when creating an index on a table you will need to define which fields take part in the index. There are many interfaces which either require or return a <STRONG>Fields </STRONG>collection; these include <STRONG>IClass </STRONG>(therefore also <STRONG>IObjectClass </STRONG>and <STRONG>IFeatureClass</STRONG>), <STRONG>ICursor</STRONG>, <STRONG>IIndex</STRONG>, <STRONG>IFeatureClassDraw</STRONG>, <STRONG>IRowBuffer</STRONG>, <STRONG>ISimpleDataConverter</STRONG>, <STRONG>ITableSort </STRONG>and <STRONG>IValidate</STRONG>.</P>

FindField(string)

The index of the field with the specified name.

virtual int FindField(string Name)

Parameters

Name string

Returns

int

Remarks

If FindField returns -1, the Field could not be found in the Fields collection.

Developers working with SDE should be aware of qualified field names and their impact on calls to FindField. For more information, see the IFields2 interface.

FullName

The associated name object.

virtual IName FullName { get; }

Returns

IName

Remarks

The FullName property returns a Name object for the dataset. The Name object can be persisted and provides a way to get back to the dataset in a future session of the application, via the Open method on the Name object.

GetCurrentSchemaLocks(out IEnumSchemaLockInfo)

The list of current locks.

virtual void GetCurrentSchemaLocks(out IEnumSchemaLockInfo schemaLockInfo)

Parameters

schemaLockInfo IEnumSchemaLockInfo

Remarks

The ISchemaLockInfo interface is used in concert with ISchemaLock to provide information about a schema lock, for example, whether it is shared or exclusive and for ArcSDE geodatabases, the name of the user who has the lock.  Note that there will always be at least one schema lock on the dataset.  Also note that by checking the schema locks on a dataset a shared schema lock is applied to the data. 

GetRow(long)

The row from the database with the specified object ID.

virtual IRow GetRow(long OID)

Parameters

OID long

Returns

IRow

Remarks

The GetRow method returns an existing row object, given its object ID value. The caller can query the returned row object for additional object specific interfaces. The retrieved row may be modified; calling Store on the row object after changing it will trigger messages to related objects and will mark the row for committing to the database.

GetRows(object, bool)

The cursor of rows based on a set of object ids.

virtual ICursor GetRows(object oids, bool Recycling)

Parameters

oids object
Recycling bool

Returns

ICursor

Remarks

The GetRows method returns a cursor that may be used to retrieve a set of rows specified by the input array of object id values. See the description of the Search method to understand the meaning of the recycling parameter. It is far more efficient to retrieve a set of rows using the GetRows method than it is to retrieve each individual row using the GetRow method. The retrieved rows may be modified; Store should be called on the row objects after changing them.

The oids parameter should be passed an integer array. For example:

 

[C#]

// Get a recycling cursor for the OID array.

int[] oidArray = new int[] { 10844, 10853, 10871 };

ICursor cursor = table.GetRows(oidArray, true);

HasOID

Indicates if the class has an object identity (OID) field.

virtual bool HasOID { get; }

Returns

bool

HasSubtype

Indicates if the table has subtypes.

virtual bool HasSubtype { get; }

Returns

bool

Remarks

This property returns a boolean value indicating if the object class has subtypes defined. If there are no subtypes defined, it returns FALSE , if there are subypes defined it returns TRUE.

IClassSchemaEdit2_AlterAliasName(string)

virtual void IClassSchemaEdit2_AlterAliasName(string Name)

Parameters

Name string

IClassSchemaEdit2_AlterClassExtensionCLSID(UID, IPropertySet)

virtual void IClassSchemaEdit2_AlterClassExtensionCLSID(UID ClassExtensionCLSID, IPropertySet classExtensionProperties)

Parameters

ClassExtensionCLSID UID
classExtensionProperties IPropertySet

IClassSchemaEdit2_AlterDefaultValue(string, object)

virtual void IClassSchemaEdit2_AlterDefaultValue(string FieldName, object Value)

Parameters

FieldName string
Value object

IClassSchemaEdit2_AlterDomain(string, IDomain)

virtual void IClassSchemaEdit2_AlterDomain(string FieldName, IDomain Domain)

Parameters

FieldName string
Domain IDomain

IClassSchemaEdit2_AlterFieldAliasName(string, string)

virtual void IClassSchemaEdit2_AlterFieldAliasName(string FieldName, string AliasName)

Parameters

FieldName string
AliasName string

IClassSchemaEdit2_AlterFieldModelName(string, string)

virtual void IClassSchemaEdit2_AlterFieldModelName(string FieldName, string ModelName)

Parameters

FieldName string
ModelName string

IClassSchemaEdit2_AlterInstanceCLSID(UID)

virtual void IClassSchemaEdit2_AlterInstanceCLSID(UID InstanceCLSID)

Parameters

InstanceCLSID UID

IClassSchemaEdit2_AlterModelName(string)

virtual void IClassSchemaEdit2_AlterModelName(string Name)

Parameters

Name string

IClassSchemaEdit2_RegisterAsObjectClass(string, string)

virtual int IClassSchemaEdit2_RegisterAsObjectClass(string suggestedOIDFieldName, string ConfigKeyword)

Parameters

suggestedOIDFieldName string
ConfigKeyword string

Returns

int

IClassSchemaEdit3_AlterAliasName(string)

virtual void IClassSchemaEdit3_AlterAliasName(string Name)

Parameters

Name string

IClassSchemaEdit3_AlterClassExtensionCLSID(UID, IPropertySet)

virtual void IClassSchemaEdit3_AlterClassExtensionCLSID(UID ClassExtensionCLSID, IPropertySet classExtensionProperties)

Parameters

ClassExtensionCLSID UID
classExtensionProperties IPropertySet

IClassSchemaEdit3_AlterClassExtensionProperties(IPropertySet)

virtual void IClassSchemaEdit3_AlterClassExtensionProperties(IPropertySet classExtensionProperties)

Parameters

classExtensionProperties IPropertySet

IClassSchemaEdit3_AlterDefaultValue(string, object)

virtual void IClassSchemaEdit3_AlterDefaultValue(string FieldName, object Value)

Parameters

FieldName string
Value object

IClassSchemaEdit3_AlterDomain(string, IDomain)

virtual void IClassSchemaEdit3_AlterDomain(string FieldName, IDomain Domain)

Parameters

FieldName string
Domain IDomain

IClassSchemaEdit3_AlterFieldAliasName(string, string)

virtual void IClassSchemaEdit3_AlterFieldAliasName(string FieldName, string AliasName)

Parameters

FieldName string
AliasName string

IClassSchemaEdit3_AlterFieldModelName(string, string)

virtual void IClassSchemaEdit3_AlterFieldModelName(string FieldName, string ModelName)

Parameters

FieldName string
ModelName string

IClassSchemaEdit3_AlterInstanceCLSID(UID)

virtual void IClassSchemaEdit3_AlterInstanceCLSID(UID InstanceCLSID)

Parameters

InstanceCLSID UID

IClassSchemaEdit3_AlterModelName(string)

virtual void IClassSchemaEdit3_AlterModelName(string Name)

Parameters

Name string

IClassSchemaEdit3_RegisterAsObjectClass(string, string)

virtual int IClassSchemaEdit3_RegisterAsObjectClass(string suggestedOIDFieldName, string ConfigKeyword)

Parameters

suggestedOIDFieldName string
ConfigKeyword string

Returns

int

IClassSchemaEdit4_AddGlobalID(string)

virtual void IClassSchemaEdit4_AddGlobalID(string FieldName)

Parameters

FieldName string

IClassSchemaEdit4_AlterAliasName(string)

virtual void IClassSchemaEdit4_AlterAliasName(string Name)

Parameters

Name string

IClassSchemaEdit4_AlterClassExtensionCLSID(UID, IPropertySet)

virtual void IClassSchemaEdit4_AlterClassExtensionCLSID(UID ClassExtensionCLSID, IPropertySet classExtensionProperties)

Parameters

ClassExtensionCLSID UID
classExtensionProperties IPropertySet

IClassSchemaEdit4_AlterClassExtensionProperties(IPropertySet)

virtual void IClassSchemaEdit4_AlterClassExtensionProperties(IPropertySet classExtensionProperties)

Parameters

classExtensionProperties IPropertySet

IClassSchemaEdit4_AlterDefaultValue(string, object)

virtual void IClassSchemaEdit4_AlterDefaultValue(string FieldName, object Value)

Parameters

FieldName string
Value object

IClassSchemaEdit4_AlterDomain(string, IDomain)

virtual void IClassSchemaEdit4_AlterDomain(string FieldName, IDomain Domain)

Parameters

FieldName string
Domain IDomain

IClassSchemaEdit4_AlterFieldAliasName(string, string)

virtual void IClassSchemaEdit4_AlterFieldAliasName(string FieldName, string AliasName)

Parameters

FieldName string
AliasName string

IClassSchemaEdit4_AlterFieldModelName(string, string)

virtual void IClassSchemaEdit4_AlterFieldModelName(string FieldName, string ModelName)

Parameters

FieldName string
ModelName string

IClassSchemaEdit4_AlterInstanceCLSID(UID)

virtual void IClassSchemaEdit4_AlterInstanceCLSID(UID InstanceCLSID)

Parameters

InstanceCLSID UID

IClassSchemaEdit4_AlterModelName(string)

virtual void IClassSchemaEdit4_AlterModelName(string Name)

Parameters

Name string

IClassSchemaEdit4_DeleteGlobalID()

virtual void IClassSchemaEdit4_DeleteGlobalID()

IClassSchemaEdit4_RegisterAsObjectClass(string, string)

virtual int IClassSchemaEdit4_RegisterAsObjectClass(string suggestedOIDFieldName, string ConfigKeyword)

Parameters

suggestedOIDFieldName string
ConfigKeyword string

Returns

int

IObjectClassInfo2_CanBypassStoreMethod()

Indicates if updates to objects can bypass the Store method and OnChange notifications for efficiency.

virtual bool IObjectClassInfo2_CanBypassStoreMethod()

Returns

bool

Remarks

CanBypassStore is a convenience method that returns True if the instances of this object class have no custom behavior associated with creating or updating objects and if the object class does not participate in composite relationship classes or in relationship classes that require object notification. A return value of True implies that insert cursors handed out by the geodatabase will internally bypass the CreateRow and Store mechanisms when creating objects. A return value of False indicates that insert cursors will not bypass custom Store or OnChanged behavior implemented by the custom row object for this class.

By default, this method returns False for custom object classes. The developer of a custom object class can change this behavior by implementing this interface on the class extension associated with the class and returning True for the method.

In addition, a developer can implement this interface on the class extension of a simple class and set this property to False . Doing this will ensure that when features in the class are inserted, updated or deleted by editor tools that use insert and update cursors, such as Planarize, Create Features and the Object Loader do not bypass Store or OnChanged behavior. By default, this property for a simple class is logically True, meaning these tools will not broacast Geodatabase events which in turn are not rebroadcast as editor events (for which a custom editor application may be listening). Set this to False for those classes for which you always want to have these events broadcast. Alternatively, this can be set globally for the entire edit session using the IWorkspaceEditControl interface.

IObjectClass_AddField(IField)

virtual void IObjectClass_AddField(IField Field)

Parameters

Field IField

IObjectClass_AddIndex(IIndex)

virtual void IObjectClass_AddIndex(IIndex Index)

Parameters

Index IIndex

IObjectClass_CLSID

virtual UID IObjectClass_CLSID { get; }

Returns

UID

IObjectClass_DeleteField(IField)

virtual void IObjectClass_DeleteField(IField Field)

Parameters

Field IField

IObjectClass_DeleteIndex(IIndex)

virtual void IObjectClass_DeleteIndex(IIndex Index)

Parameters

Index IIndex

IObjectClass_EXTCLSID

virtual UID IObjectClass_EXTCLSID { get; }

Returns

UID

IObjectClass_Extension

virtual object IObjectClass_Extension { get; }

Returns

object

IObjectClass_ExtensionProperties

virtual IPropertySet IObjectClass_ExtensionProperties { get; }

Returns

IPropertySet

IObjectClass_Fields

virtual IFields IObjectClass_Fields { get; }

Returns

IFields

IObjectClass_FindField(string)

virtual int IObjectClass_FindField(string Name)

Parameters

Name string

Returns

int

IObjectClass_HasOID

virtual bool IObjectClass_HasOID { get; }

Returns

bool

IObjectClass_Indexes

virtual IIndexes IObjectClass_Indexes { get; }

Returns

IIndexes

IObjectClass_OIDFieldName

virtual string IObjectClass_OIDFieldName { get; }

Returns

string

ITable_AddField(IField)

virtual void ITable_AddField(IField Field)

Parameters

Field IField

ITable_AddIndex(IIndex)

virtual void ITable_AddIndex(IIndex Index)

Parameters

Index IIndex

ITable_CLSID

virtual UID ITable_CLSID { get; }

Returns

UID

ITable_DeleteField(IField)

virtual void ITable_DeleteField(IField Field)

Parameters

Field IField

ITable_DeleteIndex(IIndex)

virtual void ITable_DeleteIndex(IIndex Index)

Parameters

Index IIndex

ITable_EXTCLSID

virtual UID ITable_EXTCLSID { get; }

Returns

UID

ITable_Extension

virtual object ITable_Extension { get; }

Returns

object

ITable_ExtensionProperties

virtual IPropertySet ITable_ExtensionProperties { get; }

Returns

IPropertySet

ITable_Fields

virtual IFields ITable_Fields { get; }

Returns

IFields

ITable_FindField(string)

virtual int ITable_FindField(string Name)

Parameters

Name string

Returns

int

ITable_HasOID

virtual bool ITable_HasOID { get; }

Returns

bool

ITable_Indexes

virtual IIndexes ITable_Indexes { get; }

Returns

IIndexes

ITable_OIDFieldName

virtual string ITable_OIDFieldName { get; }

Returns

string

IValidation2_AddRule(IRule)

virtual void IValidation2_AddRule(IRule Rule)

Parameters

Rule IRule

IValidation2_DeleteRule(IRule)

virtual void IValidation2_DeleteRule(IRule Rule)

Parameters

Rule IRule

IValidation2_Rules

virtual IEnumRule IValidation2_Rules { get; }

Returns

IEnumRule

IValidation2_RulesByField[string]

virtual IEnumRule IValidation2_RulesByField[string FieldName] { get; }

Parameters

FieldName string

Returns

IEnumRule

IValidation2_RulesBySubtypeCode[int]

virtual IEnumRule IValidation2_RulesBySubtypeCode[int SubtypeCode] { get; }

Parameters

SubtypeCode int

Returns

IEnumRule

IValidation2_Validate(IQueryFilter, IWorkspace)

virtual ISelectionSet IValidation2_Validate(IQueryFilter Selection, IWorkspace Workspace)

Parameters

Selection IQueryFilter
Workspace IWorkspace

Returns

ISelectionSet

IValidation2_ValidateSelection(ISelectionSet, IWorkspace)

virtual ISelectionSet IValidation2_ValidateSelection(ISelectionSet Selection, IWorkspace Workspace)

Parameters

Selection ISelectionSet
Workspace IWorkspace

Returns

ISelectionSet

IValidation2_ValidateSet(ISet)

virtual ISet IValidation2_ValidateSet(ISet Selection)

Parameters

Selection ISet

Returns

ISet

Indexes

The indexes collection for this object class.

virtual IIndexes Indexes { get; }

Returns

IIndexes

Remarks

<P>The <STRONG>Indexes </STRONG>object represents a collection of indexes on a table. Indexes are designed to improve access times to data. The <STRONG>Indexes </STRONG>collection object operates in a very similar way to the Fields collection object.</P>

Insert(bool)

Returns a cursor that can be used to insert new Rows.

virtual ICursor Insert(bool useBuffering)

Parameters

useBuffering bool

Returns

ICursor

Remarks

The Insert method returns an insert cursor that can be used to bulk insert rows. It offers significantly faster performance than multiple calls to CreateRow and Store for tables storing simple rows and simple features (that is, for tables whose CLSID is esriGeoDatabase.Row, esriGeoDatabase.Object, or esriGeoDatabase.Feature).

Insert cursors on tables containing complex objects use the CreateRow and Store methods to achieve polymorphism, and there is no difference in performance in these cases.

When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.

IsBeingEdited()

True if the dataset is being edited.

virtual bool IsBeingEdited()

Returns

bool

Remarks

Once an edit session has been started on a workspace, the IsBeingEdited method on the IDatasetEdit interface can be used to determine if a particular dataset is participating in the edit session.

The reasons why a dataset may not participate include the connected user has no privileges or permission to edit the dataset, the connected user is not licensed to edit this type of dataset, or the dataset is not versioned but a versioned edit session has been started (or vice versa).

IsTimeInUTC

Change the property to determine Editor Tracking times are recorded in UTC.

virtual bool IsTimeInUTC { set; }

Returns

bool

Remarks

If you don't specify this, time will be recorded in UTC.

ModelName

The model name of the field.

virtual string ModelName { get; set; }

Returns

string

Remarks

Returns the model name currently associated with the field or object class.

Name

The name of the Dataset.

virtual string Name { get; }

Returns

string

OIDFieldName

The name of the field corresponding to the OID.

virtual string OIDFieldName { get; }

Returns

string

ObjectClassID

The unique ID for the object class.

virtual int ObjectClassID { get; }

Returns

int

Remarks

Each feature class or table registered with the geodatabase is an object class. Object classes have a unique ID which distinguishes them from other object classes in the geodatabase. The ObjectClassID property returns this ID as a long. The object class ID is assigned by the system when the class is created, or registered with the geodatabase, it cannot be modified.

Those feature classes and tables that are in the database, but not registered with the geodatabase will always have an object class ID of -1.

PropertySet

The set of properties for the dataset.

virtual IPropertySet PropertySet { get; }

Returns

IPropertySet

Remarks

Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.

IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.

RegisterAsObjectClass(string, string)

Registers this class with the database, assigning it a class id and creating an object id column.

virtual int RegisterAsObjectClass(string suggestedOIDFieldName, string ConfigKeyword)

Parameters

suggestedOIDFieldName string
ConfigKeyword string

Returns

int

RegisterGlobalIDColumn(string)

Registers this column as an Global ID with the database.

virtual void RegisterGlobalIDColumn(string columnName)

Parameters

columnName string

Remarks

This method converts a field of type GUID to a field of type GlobalID.

The object must reference an unversioned ArcSDE feature class or table.  Use the IVersionedObject3::IsRegisteredAsVersioned property to determine if a dataset is versioned.  Additionally the dataset must not be replicated. Use the IWorkspaceReplicasAdmin2::IsReferencedByReplica method to determine if the dataset is part of a replica.

A Global ID field must not already exist on the dataset referenced by the object. Use the IClassEx::HasGlobalID property to determine if a dataset has a Global ID field.

The columnName must reference a field of type GUID in the dataset referenced by the object.  The IField::Type property can be used to determine a field type. 

There must be no duplicate values in the GUID field.   See the DataStatistics coclass for more information.

Another requirement is that the GUID field must be not nullable.  See the IField::IsNullable property for more information.  By default, GUID columns are nullable.  However, when adding a GUID column to a dataset you can specify this field be not nullable.  This is possible whether or not the dataset you are adding the new GUID field to already has populated rows.  If you add a GUID column to a popluated dataset, and set the IsNullable property of this field to be false, the GUID values will be populated with a default value of {00000000-0000-0000-0000-000000000000}.

If you have a GUID field but it is nullable, to satisfy the requirements of this method, you can simply add a new GUID field, ensure you set the IsNullable property to false, and calculate the values from your GUID field into the newly added GUID field.

Errors will be returned if any of the above requirements are not met.

RelationshipClasses[esriRelRole]

The relationship classes in which this object class participates in for the specified role.

virtual IEnumRelationshipClass RelationshipClasses[esriRelRole Role] { get; }

Parameters

Role esriRelRole

Returns

IEnumRelationshipClass

Remarks

Object classes in a geodatabase may participate in any number of relationships classes. The RelationshipClasses property allows you to get a list of those relationship classes that the object class participates in by what role it plays (origin, destination, or either) defined by the esriRelRole enumeration used when you call this property. This property returns a IEnumRelationshipClass interface which you can use to loop through those relationship classes that are returned.

Rename(string)

Renames this Dataset.

virtual void Rename(string Name)

Parameters

Name string

Remarks

IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network.  In addition, certain feature classes, such as network feature classes, cannot be renamed.

RowCount(IQueryFilter)

The number of Rows selected by the specified query.

virtual long RowCount(IQueryFilter QueryFilter)

Parameters

QueryFilter IQueryFilter

Returns

long

Rules

The rules associated with the class.

virtual IEnumRule Rules { get; }

Returns

IEnumRule

Remarks

Property Rules returns a IEnumRule enumerator hydrated with all of the rules associated with the object class.

RulesByField[string]

The rules associated with the attribute.

virtual IEnumRule RulesByField[string FieldName] { get; }

Parameters

FieldName string

Returns

IEnumRule

RulesBySubtypeCode[int]

The rules associated with the subtype.

virtual IEnumRule RulesBySubtypeCode[int SubtypeCode] { get; }

Parameters

SubtypeCode int

Returns

IEnumRule

Search(IQueryFilter, bool)

An object cursor that can be used to fetch row objects selected by the specified query.

virtual ICursor Search(IQueryFilter QueryFilter, bool Recycling)

Parameters

QueryFilter IQueryFilter
Recycling bool

Returns

ICursor

Remarks

The Search method returns a search cursor that can be used to retrieve rows specified by a query filter. The recycling parameter controls row object allocation behavior. Recycling cursors rehydrate a single row object on each fetch and can be used to optimize read-only access, for example, when drawing. It is illegal to maintain a reference on a row object returned by a recycling cursor across multiple calls to NextRow on the cursor.

Row objects returned by a recycling cursor should not be modified. Non-recycling cursors return a separate row object on each fetch. The objects returned by a non-recycling cursor may be modified and stored with polymorphic behavior. The geodatabase guarantees ‘unique instance semantics’ on non-recycling row objects fetched during an edit session. If the row object to be retrieved by a call to search has already been instantiated and is being referenced by the calling application, then a reference to the existing row object is returned.

Non-recycling feature cursors returned from the Search method *MUST* be used when copying features from the cursor into an insert cursor of another class.  This is because a recycling cursor reuses the same geometry and under some circumstances all of the features inserted into the insert cursor may have the same geometry.  Using a non-recycling cursor ensures that each geometry is unique.

When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.

Select(IQueryFilter, esriSelectionType, esriSelectionOption, IWorkspace)

A selection that contains the object ids selected by the specified query.

virtual ISelectionSet Select(IQueryFilter QueryFilter, esriSelectionType selType, esriSelectionOption selOption, IWorkspace selectionContainer)

Parameters

QueryFilter IQueryFilter
selType esriSelectionType
selOption esriSelectionOption
selectionContainer IWorkspace

Returns

ISelectionSet

Remarks

The Select method returns a selection set that holds either row IDs or row objects from the Table depending on the selection option. Multiple selection sets can be created on the same table. It is up to a client application or object to keep a reference on created selections and use them as appropriate. For example, a FeatureLayer creates and uses selections on a FeatureClass (a type of Table).

The selType parameter determines the type of selection set that will be created: an ID set, a snapshot, or a hybrid. See the ISelectionSet interface for a comparison of the three types.

When calling Select the selectionContainer parameter is no longer required. A null value should be passed as this parameter. 

Subsets

Datasets contained within this dataset.

virtual IEnumDataset Subsets { get; }

Returns

IEnumDataset

Remarks

IDataset::Subsets is not supported for Graph objects such as a Geometric Network.  To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.

SubtypeFieldIndex

The subtype field index.

virtual int SubtypeFieldIndex { get; }

Returns

int

Remarks

This property returns the index of the field in the object class which stores the subtype codes. The field index is returned as a Long.

SubtypeFieldName

The subtype field name.

virtual string SubtypeFieldName { get; set; }

Returns

string

Remarks

The SubtypeFieldName property is used to either set or return string value for the field that contains the subtypes for this object class. To assign the subtype field, set SubtypeFieldName equal to the name of the field:

SubtypeName[int]

The subtype name.

virtual string SubtypeName[int SubtypeCode] { get; }

Parameters

SubtypeCode int

Returns

string

Remarks

This property returns the name of a subtype for a given subtype code for the associated object class. The subtype code is required as a Long and returns the name of the subtype as a String.

Subtypes

The subtypes associated with the class.

virtual IEnumSubtype Subtypes { get; }

Returns

IEnumSubtype

Remarks

Every ObjectClass has a default subtype code. If the user has not explicitly specified a default subtype or a subtype field, then DefaultSubtypeCode will return a subtype code of zero. Additionally, you can query the HasSubtype property; a value of False indicates an absence of a default subtype code, True indicates the presence of a default subtype code.

If the client instead asks for the enumeration of subtypes associated with an ObjectClass and no subtype has been previously added to the ObjectClass, then the enumerator will contain a single entry with a code of zero. The subtype field index value will be –1 if a default subtype has not been previously specified. Subtypes may only be short or long integers (esriFieldTypeSmallInteger or esriFieldTypeInteger). When setting the default subtype code, if one already exists, then it will be deleted. A subtype field must have been specified prior to setting the subtype code value.

Every type of field, except for esriFieldTypeShape, may have a default value. When setting the default value (which my be assigned on a subtype basis), it will be checked against the field’s associated Domain (if one exists) for validity.

This property returns all of the subtypes for the associated object class. Subtypes returns an IEnumSubtype enumeration which you can loop through to get all of the subtypes.

Type

The type of the Dataset.

virtual esriDatasetType Type { get; }

Returns

esriDatasetType

Remarks

The Type property returns the an esriDatasetType value indicating the dataset type, such as esriDTTable or esriDTFeatureClass.

UnregisterGlobalIDColumn(string)

Unregisters this column as an OID with the database.

virtual void UnregisterGlobalIDColumn(string columnName)

Parameters

columnName string

Remarks

This method converts a field of type GlobalID to a field of type GUID.

The object must reference an unversioned ArcSDE feature class or table.  Use the IVersionedObject3::IsRegisteredAsVersioned property to determine if a dataset is versioned.  Additionally the dataset must not be replicated. Use the IWorkspaceReplicasAdmin2::IsReferencedByReplica method to determine if the dataset is part of a replica.

A Global ID field must not already exist on the dataset referenced by the object. Use the IClassEx::HasGlobalID property to determine if a dataset has a Global ID field.

The columnName must reference a field of type GlobalID in the dataset referenced by the object.  The IField::Type property can be used to determine a field type. 

Errors will be returned if any of the above requirements are not met.

Update(IQueryFilter, bool)

Returns a cursor that can be used to update Rows selected by the specified query.

virtual ICursor Update(IQueryFilter QueryFilter, bool Recycling)

Parameters

QueryFilter IQueryFilter
Recycling bool

Returns

ICursor

Remarks

The Update method returns an update cursor that can be used to update or delete rows. It offers somewhat faster performance than multiple calls to Store or Delete on row objects fetched using a non-recycling search cursor for tables storing simple rows and simple features. There is no difference in performance for complex objects and features.

When using cursors within an edit session, they should always be scoped to edit operations. In other words, a cursor should be created after an edit operation has begun and should not be used once that edit operation has been stopped or aborted.

UpdateSearchedRows(IQueryFilter, IRowBuffer)

Update the Rows in the database selected by the specified query.

virtual void UpdateSearchedRows(IQueryFilter QueryFilter, IRowBuffer buffer)

Parameters

QueryFilter IQueryFilter
buffer IRowBuffer

Validate(IQueryFilter, IWorkspace)

Validates the selection.

virtual ISelectionSet Validate(IQueryFilter Selection, IWorkspace Workspace)

Parameters

Selection IQueryFilter
Workspace IWorkspace

Returns

ISelectionSet

Remarks

Validate on a row occurs in five steps:

  1. Validate the subtype

  2. Validate the attribute rules

  3. Validate the network connectivity rules (if network feature)

  4. Validate the relationship rules

  5. Perform custom validation (using optional class extension)

The validate process stops once a row is found invalid. For example, if a network feature violates an attribute rule, the validation process stops and the feature's network connectivity rules are not evaluated until the attribute rule violation is corrected.

ValidateSelection(ISelectionSet, IWorkspace)

Validates the selection.

virtual ISelectionSet ValidateSelection(ISelectionSet Selection, IWorkspace Workspace)

Parameters

Selection ISelectionSet
Workspace IWorkspace

Returns

ISelectionSet

ValidateSet(ISet)

Validates the set.

virtual ISet ValidateSet(ISet Selection)

Parameters

Selection ISet

Returns

ISet

Workspace

The workspace containing this dataset.

virtual IWorkspace Workspace { get; }

Returns

IWorkspace

Remarks

<p>A Workspace is a container of spatial and non-spatial datasets such as feature classes, raster datasets, and tables. It provides methods to instantiate existing datasets and to create new datasets. Workspaces are classified into types specified by the <b><a href="esriWorkspaceType.htm">esriWorkspaceType</a></b> enumerator: FileSystemWorkspace, LocalDatabaseWorkspace, and RemoteDatabaseWorkspace. Shapefiles and ArcGIS for Desktop Advanced workspaces are examples of FileSystemWorkspace. A personal geodatabase stored in an Access or a File Geodatabase is an example of a LocalDatabaseWorkspace. A geodatabase stored in an RDBMS such as Oracle, DB2, SQL Server, or Informix and accessed via ArcSDE is an example of a RemoteDatabaseWorkspace.</p> <p>A Workspace hands out a <b><a href="WorkspaceName.htm">WorkspaceName</a> </b>object as the value of its FullName property. For example, the WorkspaceName for a workspace can be persisted in a map document. An application can call the <b>Open()</b> method on the workspace name after loading it from persistent storage to connect to and get an object reference to the workspace.</p>