Interface IShields

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

Provides access to a container for refining directions with shields.

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("9E82750B-BDDC-40A1-9A63-FF699FFC55E1")]
public interface IShields

Properties

CombinedFieldName

The field name whose values contain the whole address description.

string CombinedFieldName { get; set; }

Property Value

string

Remarks

If the Shields information is specified within a single field, the field name can be specified and accessed through hte CombinedFieldName property.

NumberFieldName

The field name whose values contain the house number.

string NumberFieldName { get; set; }

Property Value

string

Remarks

If Shields information is specified in two different fields, the field containing the Number information can be accessed and specified with the NumberFieldName property.

ShieldCount

The number of shields.

int ShieldCount { get; }

Property Value

int

Remarks

Returns a count of the number of shields that have been specified.

ShieldDescription[int]

The shield description by index.

string ShieldDescription[int Index] { get; }

Parameters

Index int

Property Value

string

Remarks

Returns the ShieldDescription value specified by the index.  The ShieldType is added with the AddShield method.  Examples of ShieldType and ShieldDescriptions pairs include:

ShieldType ShieldDescription
I Interstate
S State
T Trans Canada

ShieldType[int]

The shield type by index.

string ShieldType[int Index] { get; }

Parameters

Index int

Property Value

string

Remarks

Returns the ShieldType value specified by the index.  The ShieldType is added with the AddShield method.  Examples of ShieldType and ShieldDescriptions pairs include:

ShieldType ShieldDescription
I Interstate
S State
T Trans Canada

TypeFieldName

The field name whose values contain the street type.

string TypeFieldName { get; set; }

Property Value

string

Remarks

If Shields information is specified in two different fields, the field containing the Type information can be accessed and specified with the TypeFieldName property.

UseCombinedField

Indicates if the combined field should be used for directions.

bool UseCombinedField { get; set; }

Property Value

bool

Remarks

If the Shields information is specified in a single field, the UseCombinedField should be set to True.  If the Shields information is contained within two different fields, the UseCombinedField should be set to False.

Methods

AddShield(string, string)

Adds a shield of the given type.

void AddShield(string Type, string Description)

Parameters

Type string
Description string

Remarks

The AddShield method should be used to add ShieldType, ShieldDescription pairs.  When Directions are generated, the ShieldType value will be replaced by it's corresponding ShieldDescription.  Examples of ShieldType and ShieldDescription pairs include:

ShieldType ShieldDescription
I Interstate
S State
T Trans Canada

DeleteShield(int)

Deletes a shield by index.

void DeleteShield(int Index)

Parameters

Index int

Remarks

DeleteShield removes the shield of the specified index from the collection.