ArcGIS Developer Help

IFlagDisplay Interface

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Use the IFlagDisplay interface to specify the feature on which a flag object is located. Using this interface, you can also specify the coordinates and symbology for the flag object.

[C#]

The following code can be used to create a flag on a junction feature:

  IJunctionFlagDisplay junctionFlagDisplay = new JunctionFlagDisplayClass() as IJunctionFlagDisplay;

The following code can be used to create a flag on an edge feature:

  IEdgeFlagDisplay edgeFlagDisplay = new EdgeFlagDisplayClass() as IEdgeFlagDisplay;

Once either flag object is created, you need to get a reference to the IFlagDisplay interface to specify to which feature the flag belongs. This requires knowing three items about a feature:

1. UserClassID - This is the ID of the feature class which the feature belongs to.

2. UserID - This is the ID of the feature within the feature class.

3. UserSubID - This is the ID of an individual element within a feature.

These three properties can be queried from a network element ID (EID) by calling INetElements::QueryIDs.

Using the junction flag as an example we can populate the parameters of the object:

  IFlagDisplay flagDisplay = junctionFlagDisplay as IFlagDisplay;
  flagDisplay.FeatureClassID = userClassID;
  flagDisplay.FID = userID;
  flagDisplay.SubID = userSubID;

The utility network analysis extension now needs to know about this flag to use it in any tracing functions. You can add the flag to the extensions using the INetworkAnalysisExtFlags interface.

[C++]

Once the EdgeFlagDisplay or JunctionFlagDisplay object is created, you need to get a reference to the IFlagDisplay interface to specify to which feature the flag belongs. This requires knowing three items about a feature:

1. UserClassID - This is the ID of the feature class which the feature belongs to.

2. UserID - This is the ID of the feature within the feature class.

3. UserSubID - This is the ID of an individual element within a feature.

These three properties can be queried from a network element ID (EID) by calling INetElements::QueryIDs.

 

The utility network analysis extension now needs to know about this flag to use it in any tracing functions. You can add the flag to the extensions using the INetworkAnalysisExtFlags interface.

[Visual Basic .NET]

The following code can be used to create a flag on a junction feature:

  Dim junctionFlagDisplay As IJunctionFlagDisplay = New JunctionFlagDisplay

The following code can be used to create a flag on an edge feature:

  Dim edgeFlagDisplay As IEdgeFlagDisplay = New EdgeFlagDisplay

Once either flag object is created, you need to get a reference to the IFlagDisplay interface to specify to which feature the flag belongs. This requires knowing three items about a feature:

1. UserClassID - This is the ID of the feature class which the feature belongs to.

2. UserID - This is the ID of the feature within the feature class.

3. UserSubID - This is the ID of an individual element within a feature.

These three properties can be queried from a network element ID (EID) by calling INetElements::QueryIDs.

Using the junction flag as an example we can populate the parameters of the object:

  Dim flagDisplay As IFlagDisplay = CType(junctionFlagDisplay, IFlagDisplay)
  flagDisplay.FeatureClassID = userClassID
  flagDisplay.FID = userID
  flagDisplay.SubID = userSubID

The utility network analysis extension now needs to know about this flag to use it in any tracing functions. You can add the flag to the extensions using the INetworkAnalysisExtFlags interface.