IShields Interface

Provides access to a container for refining directions with shields.

Description

The IShields interface provides members that are used for refining Directions, by allow the specification of Shield information, such as the type and number of a highway. Unlike the network source level directions information, such as IFeatureNameFields, only one set of Shields information can be specified for a network dataset. Shield information is not required for Directions generation.

If shield data exists for a network source, it can be in one of two forms:

• All shield information is stored within a single field, with values such as T-C HWY 1 or US HWY 10
• The Type and Number are stored in separate fields

Members

	Name	Description
	AddShield	Adds a shield of the given type.
	CombinedFieldName	The field name whose values contain the whole address description.
	DeleteShield	Deletes a shield by index.
	NumberFieldName	The field name whose values contain the house number.
	ShieldCount	The number of shields.
	ShieldDescription	The shield description by index.
	ShieldType	The shield type by index.
	TypeFieldName	The field name whose values contain the street type.
	UseCombinedField	Indicates if the combined field should be used for directions.

IShields.AddShield Method

Adds a shield of the given type.

Public Sub AddShield ( _
    ByVal Type As String, _
    ByVal Description As String _
)

public void AddShield (
    string Type,
    string Description
);

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

IShields.CombinedFieldName Property

The field name whose values contain the whole address description.

Public Property CombinedFieldName As String

public string CombinedFieldName {get; set;}

Remarks

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

IShields.DeleteShield Method

Deletes a shield by index.

Public Sub DeleteShield ( _
    ByVal Index As Integer _
)

public void DeleteShield (
    int Index
);

Remarks

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

IShields.NumberFieldName Property

The field name whose values contain the house number.

Public Property NumberFieldName As String

public string NumberFieldName {get; set;}

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.

IShields.ShieldCount Property

The number of shields.

Public ReadOnly Property ShieldCount As Integer

public int ShieldCount {get;}

Remarks

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

IShields.ShieldDescription Property

The shield description by index.

Public Function get_ShieldDescription ( _
    ByVal Index As Integer _
) As String

public string get_ShieldDescription (
    int Index
);

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

IShields.ShieldType Property

The shield type by index.

Public Function get_ShieldType ( _
    ByVal Index As Integer _
) As String

public string get_ShieldType (
    int Index
);

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

IShields.TypeFieldName Property

The field name whose values contain the street type.

Public Property TypeFieldName As String

public string TypeFieldName {get; set;}

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.

IShields.UseCombinedField Property

Indicates if the combined field should be used for directions.

Public Property UseCombinedField As Boolean

public bool UseCombinedField {get; set;}

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.

Classes that implement IShields

Classes	Description