Indicates if the effect 'effect' related to the pole that connects the flags of the flag model named 'flagModelName' associated with the element type is set.

[Visual Basic 6.0]
Function IsPoleEffectSet(
    ByVal flagModelName As String, _
    ByVal effect As esriNgPoleEffect _
) As Boolean

[Visual Basic .NET]
Public Function IsPoleEffectSet ( _
    ByVal flagModelName As String, _
    ByVal effect As esriNgPoleEffect _
) As Boolean

[C#]
public bool IsPoleEffectSet (
    string flagModelName,
    esriNgPoleEffect effect
);

[Java]
public Boolean isPoleEffectSet (
    String flagModelName,
    esriNgPoleEffect effect
)
throws
    IOException,
    AutomationException

[C++]
HRESULT IsPoleEffectSet(
  BSTR flagModelName,
  esriNgPoleEffect effect,
  VARIANT_BOOL* isSet
);

Product Availability

Description

By default, Schematics automatically sets default values for some pole effects (see the List of default pole effect values, below). For all these effects, the IsPoleEffectSet method returns True.

For the other effects (those that are not automatically set by default), the IsPoleEffectSet method returns True only if the effect has been set:

- Either through ArcGIS Schematics Designer when defining the pole's characteristics

- Or, by calling the INgElementType SetPoleEffect method in the project code.

List of the default pole effect values

esriNgPoleDetectability: esriNgDetectable

esriNgPoleHighlightedState: esriNgNotHighlighted

esriNgPolePriority: 50 or more

esriNgPoleSelectability: esriNgSelectable

esriNgPoleVisibility: esriNgVisible

Dim pElementType As INgElementType
Dim vColor As Integer
...
If pElementType.IsPoleEffectSet("ClassicFlag", esriNgPoleLineColor) Then
    vColor = pElementType.GetPoleEffect("ClassicFlag", esriNgPoleLineColor)
    ...
End If

See Also

INgElementType Interface | INgElementType.GetPoleEffect Method | INgElementType.SetPoleEffect Method | INgElementType.RemovePoleEffect Method

Send feedback on this page