Interface IGPDataType

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll

Provides access to members of a GP Data Type.

[Guid("172A93A9-AFC1-432D-8F04-54B7309BA432")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IGPDataType

Properties

ControlCLSID

The COM class id of the data type.

UID ControlCLSID { get; }

Property Value

UID

DisplayName

The descriptive, user-friendly name.

string DisplayName { get; }

Property Value

string

Remarks

The DisplayName property returns the descriptive, user-friendly name of the DataType object.

FullName

The associated Name object.

IName FullName { get; }

Property Value

IName

Remarks

The FullName property returns the full name of the DataType object, which is an IName object.

HelpContext

The context identifier of the topic within the help file.

int HelpContext { get; }

Property Value

int

Remarks

The HelpContext property returns the context identifier to the topic inside the HelpFile for this DataType.

HelpFile

The name of the (CHM) file containing help information.

string HelpFile { get; }

Property Value

string

Remarks

The HelpFile property returns the string of the help file, which contains the help for the DataType.

MetadataFile

The name of the (XML) file containing the default metadata for this data type.

string MetadataFile { get; }

Property Value

string

Name

The name of the data type.

string Name { get; }

Property Value

string

Remarks

The Name property returns the unique name assigned to the DataType object.

Methods

CreateValue(string)

Creates a geoprocessing value object from the given string.

IGPValue CreateValue(string text)

Parameters

text string

Returns

IGPValue

Remarks

The CreateValue method creates the default Value object, which can subsequently be used in the parameter array that is passed to the Validate and the Execute methods of IGPFunction.

ValidateDataType(IGPDataType)

Validates if a given geoprocessing data type object is valid.

IGPMessage ValidateDataType(IGPDataType Type)

Parameters

Type IGPDataType

Returns

IGPMessage

Remarks

The ValidateDataType method determines if a given DataType object is compatible. The method is used by ModelBuilder to evaluate if a variable can be associated with this DataType.

ValidateValue(IGPValue, IGPDomain)

Validates if a given geoprocessing value object is the correct data type.

IGPMessage ValidateValue(IGPValue Value, IGPDomain Domain)

Parameters

Value IGPValue
Domain IGPDomain

Returns

IGPMessage

Remarks

The ValidateValue method is used to determine if a Value object is compatible with a DataType.