ArcObjects Library Reference  (Schematic)    

INgElementType.GetPoleEffect Method

Returns the effect 'effect' set for the pole that connects the flags of the flag model named 'flagModelName' associated with the element type.

[Visual Basic 6.0]
Function GetPoleEffect(
    ByVal flagModelName As String, _
    ByVal effect As esriNgPoleEffect _
) As Variant
[Visual Basic .NET]
Public Function GetPoleEffect ( _
    ByVal flagModelName As String, _
    ByVal effect As esriNgPoleEffect _
) As Object
[C#]
public object GetPoleEffect (
    string flagModelName,
    esriNgPoleEffect effect
);
[Java]
public Object getPoleEffect (
    String flagModelName,
    esriNgPoleEffect effect
)
throws
    IOException,
    AutomationException
[C++]
HRESULT GetPoleEffect(
  BSTR flagModelName,
  esriNgPoleEffect effect,
  VARIANT* effValue
);
[C++]

Parameters

flagModelName [in]

  flagModelName is a parameter of type BSTR

effect [in]

  effect is a parameter of type esriNgPoleEffect

effValue [out, retval]

  effValue is a parameter of type VARIANT

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Schematics Extension.
[Visual Basic 6.0]

Here is a sample call of the GetPoleEffect method:

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.SetPoleEffect Method | INgElementType.IsPoleEffectSet Method | INgElementType.RemovePoleEffect Method

 


Feedback Send feedback on this page