ArcObjects Library Reference  (Schematic)    

INgElementType.RemovePoleEffect Method

Removes the effect or restores the default effect 'effect' for the pole that connects the flags of the flag model named 'flagModelName' associated with the element type.

[Visual Basic 6.0]
Sub RemovePoleEffect(
    ByVal flagModelName As String, _
    ByVal effect As esriNgPoleEffect _
) As Empty
[Visual Basic .NET]
Public Sub RemovePoleEffect ( _
    ByVal flagModelName As String, _
    ByVal effect As esriNgPoleEffect _
)
[C#]
public void RemovePoleEffect (
    string flagModelName,
    esriNgPoleEffect effect
);
[Java]
public void removePoleEffect (
    String flagModelName,
    esriNgPoleEffect effect
)
throws
    IOException,
    AutomationException
[C++]
HRESULT RemovePoleEffect(
  BSTR flagModelName,
  esriNgPoleEffect effect
);
[C++]

Parameters

flagModelName [in]

  flagModelName is a parameter of type BSTR

effect [in]

  effect is a parameter of type esriNgPoleEffect

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Schematics Extension.

Description

Note that removing an effect that is always set, returns the effect to its default value. And removing an effect that is not set by default actually removes the effect: the effect is not set any more!

[Visual Basic 6.0]

Here is a sample call of the RemovePoleEffectSet method.
As this method works as the same way as the INgPole RemoveEffect method, please see also the INgPole RemoveEffect sample.

Dim pElementType As INgElementType
...
If pElementType.IsPoleEffectSet("ClassicFlag", esriNgPoleLineColor) Then
    pElementType.RemovePoleEffect "ClassicFlag", esriNgPoleLineColor
    ...
End If

See Also

INgElementType Interface | INgElementType.GetPoleEffect Method | INgElementType.IsPoleEffectSet Method | INgElementType.SetPoleEffect Method

 


Feedback Send feedback on this page