Class MEAnnotationFeatureClass

Namespace
ESRI.ArcGIS.CartoX
Assembly
ESRI.Server.CartoX.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("3FF1675E-4FFB-4D9B-9438-767CE04DE34A")]
public class MEAnnotationFeatureClass : MEAnnotationFeature, IRowEvents, IValidate, IRowSubtypes, IFeature, IObject, IRow, IFeatureBuffer, IRowBuffer, IFeatureChanges, IFeatureEvents, IMEAnnotationFeatureBridge, IRowChanges, ISupportErrorInfo, IRowCompare, IFeatureSimplify2, IFeatureSimplify, IFeatureProject
Inheritance
MEAnnotationFeatureClass
Implements
Inherited Members

Constructors

MEAnnotationFeatureClass()

public MEAnnotationFeatureClass()

Explicit Interface Implementations

AnnotationClassID

Label Class ID.

virtual int AnnotationClassID { get; set; }

Returns

int

AnnotationJSON

The JSON representing the annotation graphic for the feature.

virtual string AnnotationJSON { get; set; }

Returns

string

Class

The Object Class for the row.

virtual IObjectClass Class { get; }

Returns

IObjectClass

Delete()

Deletes the row.

virtual void Delete()

Remarks

All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

Extent

The extent of the feature.

virtual IEnvelope Extent { get; }

Returns

IEnvelope

FeatureType

The type of the feature.

virtual esriFeatureType FeatureType { get; }

Returns

esriFeatureType

Fields

The fields Collection for this row buffer.

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>

GetInvalidFields()

Returns all invalid fields.

virtual IFields GetInvalidFields()

Returns

IFields

GetInvalidRules()

The set of all invalid rules.

virtual IEnumRule GetInvalidRules()

Returns

IEnumRule

GetInvalidRulesByField(string)

The set of all invalid rules for the specified field.

virtual IEnumRule GetInvalidRulesByField(string FieldName)

Parameters

FieldName string

Returns

IEnumRule

GraphicOutline

The geometry outline of the annotation.

virtual IGeometry GraphicOutline { get; }

Returns

IGeometry

HasOID

Indicates if the row has an OID.

virtual bool HasOID { get; }

Returns

bool

Remarks

If the table has been registered with the geodatabase it will have unique Object ID, automatically created by the register tool, and the HasOID property will be set to True. Tables not registered with the geodatabase will not have an OID column and the HasOID property will be set to False.  See the IClassSchemaEdit::RegisterAsObjectClass method for more information.

IFeatureBuffer_Fields

virtual IFields IFeatureBuffer_Fields { get; }

Returns

IFields

IFeatureBuffer_Shape

The default shape in the feature buffer.

virtual IGeometry IFeatureBuffer_Shape { get; set; }

Returns

IGeometry

IFeatureBuffer_Value[int]

virtual object IFeatureBuffer_Value[int Index] { get; set; }

Parameters

Index int

Returns

object

IFeatureSimplify2_SimplifyGeometry(IGeometry)

virtual void IFeatureSimplify2_SimplifyGeometry(IGeometry Geometry)

Parameters

Geometry IGeometry

IFeature_Class

virtual IObjectClass IFeature_Class { get; }

Returns

IObjectClass

IFeature_Delete()

virtual void IFeature_Delete()

IFeature_Fields

virtual IFields IFeature_Fields { get; }

Returns

IFields

IFeature_HasOID

virtual bool IFeature_HasOID { get; }

Returns

bool

IFeature_OID

virtual long IFeature_OID { get; }

Returns

long

IFeature_Store()

virtual void IFeature_Store()

IFeature_Table

virtual ITable IFeature_Table { get; }

Returns

ITable

IFeature_Value[int]

virtual object IFeature_Value[int Index] { get; set; }

Parameters

Index int

Returns

object

IObject_Delete()

virtual void IObject_Delete()

IObject_Fields

virtual IFields IObject_Fields { get; }

Returns

IFields

IObject_HasOID

virtual bool IObject_HasOID { get; }

Returns

bool

IObject_OID

virtual long IObject_OID { get; }

Returns

long

IObject_Store()

virtual void IObject_Store()

IObject_Table

virtual ITable IObject_Table { get; }

Returns

ITable

IObject_Value[int]

virtual object IObject_Value[int Index] { get; set; }

Parameters

Index int

Returns

object

IRow_Fields

virtual IFields IRow_Fields { get; }

Returns

IFields

IRow_Value[int]

virtual object IRow_Value[int Index] { get; set; }

Parameters

Index int

Returns

object

InitDefaultValues()

The default values of the row.

virtual void InitDefaultValues()

Remarks

When creating new objects within ArcMap, the default subtype and any default values are automatically set. When objects are created programmatically, the default subtype and default values are not automatically set.  InitDefaultValues will populate fields with the specified default values.

All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation

InitShape()

Initialize the shape.

virtual void InitShape()

InterfaceSupportsErrorInfo(ref Guid)

virtual void InterfaceSupportsErrorInfo(ref Guid riid)

Parameters

riid Guid

IsEqual[IRow]

Indicates if the rows (which may be from two different versions) are the same (oid + values).

virtual bool IsEqual[IRow otherRow] { get; }

Parameters

otherRow IRow

Returns

bool

IsSimpleGeometry[IGeometry, esriNonSimpleReasonEnum]

Returns true if the input geometry is simple according to the rules appropriate for this feature.

virtual bool IsSimpleGeometry[IGeometry Geometry, out esriNonSimpleReasonEnum reason] { get; }

Parameters

Geometry IGeometry
reason esriNonSimpleReasonEnum

Returns

bool

LinkedFeatureID

Feature ID.

virtual object LinkedFeatureID { get; set; }

Returns

object

OID

The OID for the row.

virtual long OID { get; }

Returns

long

OnChanged()

An after event that is fired when a custom object is changed.

virtual void OnChanged()

Remarks

The OnChanged method is called by the geodatabase when an application program calls Store on an existing Row object.

OnDelete()

An after event that is fired when a custom object is deleted.

virtual void OnDelete()

Remarks

The OnDelete method is called by the geodatabase when an application program calls Delete on a Row object.

OnInitialize()

An after event that is fired when a custom object is initialized.

virtual void OnInitialize()

Remarks

The OnInitialize method is called by the geodatabase after hydrating a cocreated Row object with its state (its set of field values) but before handing the Row to an application program. This is an opportunity for the Row object to initialize further state and derived member variables.

OnMerge()

An after event that is fired when Features have been merged, on each deleted input Feature.

virtual void OnMerge()

OnNew()

An after event that is fired when a custom object is Stored for the first time.

virtual void OnNew()

Remarks

The OnNew method is called by the geodatabase when an application program calls Store on a newly created Row object.

OnSplit()

An after event that is fired when a Feature is split, on the deleted input Feature.

virtual void OnSplit()

OnValidate()

An after event that is fired when a custom object is validated.

virtual void OnValidate()

OriginalShape

The original shape for the feature.

virtual IGeometry OriginalShape { get; }

Returns

IGeometry

OriginalValue[int]

The value of the field at the specified index immediately after the last call to Store on the Row object.

virtual object OriginalValue[int Index] { get; }

Parameters

Index int

Returns

object

Project(ISpatialReference)

Project the feature geometry to the provided spatial reference.

virtual void Project(ISpatialReference outputSR)

Parameters

outputSR ISpatialReference

Remarks

Projects the feature from the current spatial reference to the output spatial reference.

Shape

A reference to the default shape for the feature.

virtual IGeometry Shape { get; set; }

Returns

IGeometry

Remarks

The basic process to change the shape of a feature is:

1) Get the feature's existing geometry through IFeature.ShapeCopy or create a new geometry
2) Modify the geometry
3) Set the feature's geometry using IFeature.Shape
4) Store the feature


All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

ShapeChanged

Indicates if the shape has changed.

virtual bool ShapeChanged { get; }

Returns

bool

Remarks

IFeatureChanges::ShapeChanged can be used to determine if a feature's geometry has changed.  If the feature's geometry has been changed, but IRow::Store has not yet been called, ShapeChanged will return True.  Once Store is called, ShapeChanged will return False.  ShapeChanged can also be used in an event triggered by Store, such as IRowEvents::OnChanged.  When used in this manner, ShapeChanged will return True if the feature's shape has changed.  Once Store is complete, ShapeChanged will return false.

When working with Network Features, IFeatureChanges.ShapeChanged will return true in all instances where the geometry has changed and false for any attribute or connectivity update.

ShapeCopy

A cloned copy of the default shape for the feature.

virtual IGeometry ShapeCopy { get; }

Returns

IGeometry

Remarks

The ShapeCopy property is a cloned copy of the feature’s Shape. When modifying the geometry of a feature or a set of features, use the ShapeCopy property to obtain a copy of the feature's geometry, perform the modification on the geometries, then apply the modifications by setting the geometry to the Shape property.

SimplifyGeometry(IGeometry)

Simplifies the input geometry using the rules appropriate for this feature.

virtual void SimplifyGeometry(IGeometry Geometry)

Parameters

Geometry IGeometry

Store()

Stores the row.

virtual void Store()

Remarks

The Store method is called by an application once it has modified the values of a Row. Once Store is called on a Row object, all subsequent queries within the same edit session, using the Geodatabase API, will reflect the modified state of the Row object.

All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

Calling the Store method triggers the following actions:

- The IRowEvents::OnChanged is called for the row being stored. The OnNew is called if this is a newly created row being stored for the first time. A custom row object can implement the OnChanged method and take some special action when it is called - for example; update a special column in the row

- The IRelatedObjectEvents::RelatedObjectChanged method is called for related objects in a related object class if the table for this row is an object class that participates in relationship classes with notification

Store should not be used for batch operations, such as updates or inserts.  For performing a number of inserts or updates using cursors, refer to the ITable::Insert, ITable::Update, ITable::UpdateSearchedRows , IFeatureClass::Update andIFeatureClass::Insert.  If an insert or update cursor is used on non-simple features (such as network features), the cursor will revert to using Store.

It is not necessary to explicitly call Connect on network features, this is handled polymorphically when Store is called on the feature. This is also the case with features in a Topology, Dirty Area creation is handled internally when Store is called.

Store should not be called inside of edit events, such as OnCreateFeature, OnChangeFeature or OnDeleteFeature.  Even if you are modifying the geometry or other field values, Store will be called once the event is complete.

SubtypeCode

The subtype for the row.

virtual int SubtypeCode { get; set; }

Returns

int

Remarks

When creating new objects within ArcMap, the default subtype and any default values are automatically set. When objects are created programmatically, the default subtype and default values are not automatically set. The subtype code of the feature can be specified with the SubtypeCode property.

All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

Table

The Table for the row.

virtual ITable Table { get; }

Returns

ITable

Remarks

<P>A <STRONG>Table </STRONG>object has one or more columns, referred to as fields, and contains an unordered collection of rows. Each row has for each field exactly one value in the data type of the field.</P> <P>A <STRONG>Table </STRONG>is a <STRONG>Dataset </STRONG>and properties such as the name of the table, the persistable name object for the table, and the workspace containing the table, may be obtained via the <STRONG>IDataset </STRONG>interface. In relational terms, a <STRONG>Table </STRONG>object represents an RDBMS table or view. In objected-oriented terms, a Table object represents an ObjectClass or a RelationshipClass in a geodatabase. A <STRONG>Table </STRONG>object hands out <STRONG>Row </STRONG>objects which themselves support application callable methods depending on the type of data stored in the table.</P> <P>The <STRONG>Name </STRONG>property of a <STRONG>Table</STRONG>, accessible via the <STRONG>IDataset </STRONG>interface, returns its fully qualified name. The level of qualification may vary depending on the host DBMS. For example, a table named ‘pipes’, owned by a user named ‘gas’ may be called ‘pipes’ in and Access or File Geodatabase, ‘gas.pipes’ on Oracle and ‘mydb.gas.pipes’ on SQLServer. The <STRONG>ParseTableNamemethod </STRONG>on the <STRONG>ISqlSyntax </STRONG>interface supported by the table’s workspace can be used to split the fully qualified name into its components.</P>

Validate(out string)

Validates the row.

virtual bool Validate(out string ErrorMessage)

Parameters

ErrorMessage string

Returns

bool

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.

Value[int]

The value of the field with the specified index.

virtual object Value[int Index] { get; set; }

Parameters

Index int

Returns

object

Remarks

The Index parameter is a zero based index.

ValueChanged[int]

Indicates whether the value of the field at the specified index has changed since the last call to Store on the Row object.

virtual bool ValueChanged[int Index] { get; }

Parameters

Index int

Returns

bool