Class XMLIndexClass
- Namespace
- ESRI.ArcGIS.Geodatabase
- Assembly
- ESRI.Server.Geodatabase.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("18EC559B-07BE-4F98-8960-206636BA259A")]
public class XMLIndexClass : XMLIndex, IIndexEdit, IIndex, IXMLIndexEdit, IXMLIndex, IClone, IGPValue, IXMLSerialize, IPersistStream, IPersist, IGPDescribe
- Inheritance
-
XMLIndexClass
- Implements
- Inherited Members
Constructors
XMLIndexClass()
public XMLIndexClass()
Explicit Interface Implementations
Assign(IClone)
Assigns the properties of src to the receiver.
virtual void Assign(IClone src)
Parameters
srcIClone
Clone()
Clones the receiver and assigns the result to *clone.
virtual IClone Clone()
Returns
DataType
The data type of the value object.
virtual IGPDataType DataType { get; }
Returns
Remarks
The DataType property returns the DataType object associated with this Value object.
Describe(string)
The description of the named object.
virtual object Describe(string Name)
Parameters
Namestring
Returns
Description
A textual description of the XML Index.
virtual string Description { get; }
Returns
Deserialize(IXMLSerializeData)
Deserializes an object from XML.
virtual void Deserialize(IXMLSerializeData data)
Parameters
dataIXMLSerializeData
Empty()
Clears the value object.
virtual void Empty()
Remarks
The Empty method clears this Value object and releases any associated objects.
ExcludedTags
The collection of excluded tags.
virtual IXMLIndexTags ExcludedTags { get; }
Returns
Fields
The fields collection for this index.
virtual IFields Fields { get; }
Returns
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>
GetAsText()
Provides the value of the value object.
virtual string GetAsText()
Returns
Remarks
The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.
GetClassID(out Guid)
virtual void GetClassID(out Guid pClassID)
Parameters
pClassIDGuid
GetSizeMax(out _ULARGE_INTEGER)
virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)
Parameters
pcbSize_ULARGE_INTEGER
IIndexEdit_Fields
virtual IFields IIndexEdit_Fields { get; }
Returns
IIndexEdit_Fields_2
The fields collection for this index.
virtual IFields IIndexEdit_Fields_2 { set; }
Returns
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>
IIndexEdit_IsAscending
virtual bool IIndexEdit_IsAscending { get; }
Returns
Remarks
IIndexEdit_IsAscending_2
Indicates if the index is to be ascending.
virtual bool IIndexEdit_IsAscending_2 { set; }
Returns
IIndexEdit_IsUnique
virtual bool IIndexEdit_IsUnique { get; }
Returns
IIndexEdit_IsUnique_2
Indicates if the index is to be unique.
virtual bool IIndexEdit_IsUnique_2 { set; }
Returns
IIndexEdit_Name
virtual string IIndexEdit_Name { get; }
Returns
Remarks
ArcGIS imposes a limit on the length of 16 characters on the length of attribute index names. This limit is based on the smallest allowable length within supported databases in order to facilitate distribution and sharing of data between different geodatabases.
Giving a shapefile index a name will apply the name to the index in memory, but the name will not be persisted to disk. On subsequent occasions when the indexes are opened, they will have system-defined names.
IIndexEdit_Name_2
The name of the index.
virtual string IIndexEdit_Name_2 { set; }
Returns
IPersistStream_GetClassID(out Guid)
virtual void IPersistStream_GetClassID(out Guid pClassID)
Parameters
pClassIDGuid
IXMLIndexEdit_Description
virtual string IXMLIndexEdit_Description { get; }
Returns
IXMLIndexEdit_Description_2
A textual description of the XML Index.
virtual string IXMLIndexEdit_Description_2 { set; }
Returns
IXMLIndexEdit_ExcludedTags
virtual IXMLIndexTags IXMLIndexEdit_ExcludedTags { get; }
Returns
IXMLIndexEdit_ExcludedTags_2
The collection of excluded tags.
virtual IXMLIndexTags IXMLIndexEdit_ExcludedTags_2 { set; }
Returns
IXMLIndexEdit_IncludedTags
virtual IXMLIndexTags IXMLIndexEdit_IncludedTags { get; }
Returns
IXMLIndexEdit_IncludedTags_2
The collection of included tags.
virtual IXMLIndexTags IXMLIndexEdit_IncludedTags_2 { set; }
Returns
IXMLIndexEdit_XMLIndexType
virtual esriXMLIndexType IXMLIndexEdit_XMLIndexType { get; }
Returns
IXMLIndexEdit_XMLIndexType_2
The type of XML Index.
virtual esriXMLIndexType IXMLIndexEdit_XMLIndexType_2 { set; }
Returns
IncludedTags
The collection of included tags.
virtual IXMLIndexTags IncludedTags { get; }
Returns
IsAscending
Indicates if the index is based on ascending order.
virtual bool IsAscending { get; }
Returns
IsDirty()
virtual void IsDirty()
IsEmpty()
Indicates if the value object is empty.
virtual bool IsEmpty()
Returns
Remarks
The IsEmpty method returns if this Value object has been set or not.
IsEqual(IClone)
Indicates if the receiver and other have the same properties.
virtual bool IsEqual(IClone other)
Parameters
otherIClone
Returns
IsIdentical(IClone)
Indicates if the receiver and other are the same object.
virtual bool IsIdentical(IClone other)
Parameters
otherIClone
Returns
IsUnique
Indicates if the index is unique.
virtual bool IsUnique { get; }
Returns
Remarks
Load(IStream)
virtual void Load(IStream pstm)
Parameters
pstmIStream
Name
The name of the index.
virtual string Name { get; }
Returns
Save(IStream, int)
virtual void Save(IStream pstm, int fClearDirty)
Parameters
Serialize(IXMLSerializeData)
Serializes an object to XML.
virtual void Serialize(IXMLSerializeData data)
Parameters
dataIXMLSerializeData
SetAsText(string)
Provides the value of the value object with the given string value.
virtual IGPMessage SetAsText(string text)
Parameters
textstring
Returns
Remarks
The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.
XMLIndexType
The type of XML Index.
virtual esriXMLIndexType XMLIndexType { get; }