Class MapLayerInfoClass
[ClassInterface(ClassInterfaceType.None)]
[Guid("63E9B9A2-5B83-4065-8F32-FF7732EFF3ED")]
public class MapLayerInfoClass : MapLayerInfo, IMapLayerInfo, IXMLSerialize, IPersistStream, IPersist, IMapTableInfo, IMapTableInfo2, IMapTableTimeInfo
- Inheritance
-
MapLayerInfoClass
- Implements
- Inherited Members
Constructors
MapLayerInfoClass()
public MapLayerInfoClass()
Explicit Interface Implementations
CanFind
Indicates if the layer supports the Find operation.
virtual bool CanFind { get; }
Returns
CanIdentify
Indicates if the layer supports the Identify operation.
virtual bool CanIdentify { get; }
Returns
CanScaleSymbols
Indicates if the layer supports symbol scaling.
virtual bool CanScaleSymbols { get; }
Returns
CanSelect
Indicates if the layer supports feature selection.
virtual bool CanSelect { get; }
Returns
DefinitionExpression(out string)
Returns the original definition expression on the layer.
virtual void DefinitionExpression(out string DefinitionExpression)
Parameters
DefinitionExpressionstring
Description
The description of the layer. This property is set in the General tab of the Layer Properties dialog.
virtual string Description { get; }
Returns
Deserialize(IXMLSerializeData)
Deserializes an object from XML.
virtual void Deserialize(IXMLSerializeData data)
Parameters
dataIXMLSerializeData
DisplayField
Primary display field.
virtual string DisplayField { get; }
Returns
EndTimeFieldName
End time field for the table.
virtual string EndTimeFieldName { get; }
Returns
Extent
The geographic extent of the layer.
virtual IEnvelope Extent { get; }
Returns
FieldAliases
Array of strings that contains field alias for each field in Fields property.
virtual IStringArray FieldAliases { get; }
Returns
Fields
Array of attribute fields contained in the layer.
virtual IFields Fields { get; }
Returns
FullTimeExtent
The time extent for all the data in the table.
virtual ITimeExtent FullTimeExtent { get; }
Returns
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
HTMLPopupType
Indicates if the layer has HTML popups enabled.
virtual esriServerHTMLPopupType HTMLPopupType { get; }
Returns
Remarks
StandaloneTable does not support HTMLPopup
HasAttachments
Indicates if the layer has attachments.
virtual bool HasAttachments { get; }
Returns
HasAttributes
Indicates if the layer has attributes.
virtual bool HasAttributes { get; }
Returns
HasHyperlinks
Indicates if the layer has hyperlinks.
virtual bool HasHyperlinks { get; }
Returns
HasLabels
Indicates if the layer has labels to turn on and off.
virtual bool HasLabels { get; }
Returns
HasSubtype
Indicates if the layer has Subtype.
virtual bool HasSubtype { get; }
Returns
Remarks
Note: in case when the subtype field name is invisible in the source map document, HasSubtype will return False even though the layer has Subtypes.
ID
The layer identifier. This ID is used throughout to uniquely identify the layer for all requests.
virtual int ID { get; }
Returns
Remarks
ID is a unique identifier for a layer in a given instance of ArcGIS for Server map service. It is important to note that ID, SourceID and the index of layers (see MapLayerInfos) in map document are not the same. SourceID is used for map service interaction with the GPServer.
When a map service is published, a unique ID is assigned to all layers within the original map document (.mxd) starting from 0 (zero). This ID is accessible from IMapServerObjects2, MapLayerInfo, LayerDescription, MapServerLegendInfo, MapServerIdentifyResult, MapServerFindResult and FeatureExtent.
ID is not re-usable and does not change if the order of the layer is changed. This would change the how each layer is ordered in the index of layers. Adding new a layer results in a new ID being assigned. IDs keep incrementing as new layers are added to the map service. The limit of id numbers available is the limit of Long data type.
Please note that if the layer order in the TOC of the original map is changed or if layers are added/removed, the IDs will change accordingly.
IMapTableInfo2_DisplayField
Primary display field.
virtual string IMapTableInfo2_DisplayField { get; }
Returns
IMapTableInfo2_Fields
Array of attribute fields contained in the table.
virtual IFields IMapTableInfo2_Fields { get; }
Returns
IMapTableInfo2_HTMLPopupType
Indicates if the layer has HTML popups enabled.
virtual esriServerHTMLPopupType IMapTableInfo2_HTMLPopupType { get; }
Returns
IMapTableInfo2_HasAttachments
Indicates if the layer has attachments.
virtual bool IMapTableInfo2_HasAttachments { get; }
Returns
IMapTableInfo2_HasSubtype
Indicates if the layer has Subtype.
virtual bool IMapTableInfo2_HasSubtype { get; }
Returns
IMapTableInfo2_ID
The table ID. This is a unique ID among layers and tables, and is used to identify the table in a number of methods.
virtual int IMapTableInfo2_ID { get; }
Returns
IMapTableInfo2_Name
Descriptive name of the table.
virtual string IMapTableInfo2_Name { get; }
Returns
IMapTableInfo2_OIDFieldName
The name of the OID Field.
virtual string IMapTableInfo2_OIDFieldName { get; }
Returns
IMapTableInfo2_RelateInfos
Array of relates associated to the table.
virtual IRelateInfos IMapTableInfo2_RelateInfos { get; }
Returns
IMapTableInfo_DisplayField
Primary display field.
virtual string IMapTableInfo_DisplayField { get; }
Returns
Remarks
When DisplayExpression is used in the source map document, MapServer returns the first field used in the expression.
IMapTableInfo_Fields
Array of attribute fields contained in the table.
virtual IFields IMapTableInfo_Fields { get; }
Returns
Remarks
Note: ObjectID field is always included even when the field is invisible in the source map document.
IMapTableInfo_ID
The table ID. This is a unique ID among layers and tables, and is used to identify the table in a number of methods.
virtual int IMapTableInfo_ID { get; }
Returns
IMapTableInfo_Name
Descriptive name of the table.
virtual string IMapTableInfo_Name { get; }
Returns
IPersist_GetClassID(out Guid)
virtual void IPersist_GetClassID(out Guid pClassID)
Parameters
pClassIDGuid
IsComposite
Indicates if the layer is a composite layer.
virtual bool IsComposite { get; }
Returns
IsDirty()
virtual void IsDirty()
IsFeatureLayer
Indicates if the layer is a feature layer.
virtual bool IsFeatureLayer { get; }
Returns
Load(IStream)
virtual void Load(IStream pstm)
Parameters
pstmIStream
MaxScale
The maximum visible scale for the layer.
virtual double MaxScale { get; }
Returns
MinScale
The minimum visible scale for the layer.
virtual double MinScale { get; }
Returns
Name
The name of the layer.
virtual string Name { get; }
Returns
OIDFieldName
The name of the OID Field.
virtual string OIDFieldName { get; }
Returns
ParentLayerID
If the layer is a member of a composite layer, this property identifies the parent layer.
virtual int ParentLayerID { get; }
Returns
RelateInfos
Array of relates associated to the table.
virtual IRelateInfos RelateInfos { get; }
Returns
Remarks
In order for MapServer to advertise a relationship, both source and destination layer/standalone table must be added to the source map document. For example, Layer A is related to Table B in the GeoDatabase; Layer A is added to the map while Table B is not, in this scenario, MapServer will not publicize this relationship and therefore QueryRelatedRows function cannot be used to get related row(s) for feature from Layer A.
Example: Printing a list of all relates a layer or table is participating
IRelateInfos pRIs = null;
IRelateInfo pRI = null;
pRIs = pMTI.RelateInfos;
if (pRIs == null)
{
Console.WriteLine("No relationship is available");
return;
}
for (int j = 0; j < pRIs.Count; j++)
{
pRI = pRIs.get_Element(j);
Console.WriteLine(pRI.Name + ", " + pRI.RelationshipID + ", " + pRI.RelatedTableID);
}
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
SourceDescription
The description of the source information for the layer.
virtual string SourceDescription { get; }
Returns
Remarks
With ArcGIS Server 9.3 release, this property is deprecated and always returns empty string.
StartTimeFieldName
Name of the field that has start time or time instant for a table.
virtual string StartTimeFieldName { get; }
Returns
Remarks
Time from this field is used to define when a feature/row is begun in case when the layer/table is time-enabled with two fields.
When a layer/table is time-enabled with single field, value in this field represents the moment the feature/row is recorded.
SubLayers
The list identifying the sublayers if the layer is a composite layer.
virtual ILongArray SubLayers { get; }
Returns
SupportsAdvancedQueries
Indicates if the table supports calculating advanced queries (i.e. ORDER BY clauses) on its fields.
virtual bool SupportsAdvancedQueries { get; }
Returns
SupportsStatistics
Indicates if the table supports calculating statistics on its fields.
virtual bool SupportsStatistics { get; }
Returns
SupportsTime
Indicates whether the table supports time.
virtual bool SupportsTime { get; }
Returns
TimeInterval
Suggested draw time interval for refreshing the table contents.
virtual double TimeInterval { get; }
Returns
TimeIntervalUnits
Draw time interval units.
virtual esriTimeUnits TimeIntervalUnits { get; }
Returns
TimeReference
Native TimeReference of the contents of the table.
virtual ITimeReference TimeReference { get; }
Returns
TimeValueFormat
Time field(s) values format.
virtual string TimeValueFormat { get; }
Returns
Remarks
Only application when a string or numeric field is used for time definition.
TrackIDFieldName
Field that identifies or groups unique objects for which time values are recorded in a table.
virtual string TrackIDFieldName { get; }
Returns
Type
The layer type.
virtual string Type { get; }