This document is archived and information here might be outdated.  Recommended version.


IMapControl3.FlashShape Method (ArcObjects .NET 10.4 SDK)
ArcObjects namespaces > Controls > ESRI ArcGIS Controls > Interfaces > IM > IMapControl3 Interface > IMapControl3.FlashShape Method (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (Controls)  

IMapControl3.FlashShape Method

Flashes a shape on the MapControl, duration is in milliseconds.

[Visual Basic .NET]
Public Sub FlashShape ( _
    ByVal pShape As IGeometry, _
    [ByVal nFlashes As Integer], _
    [ByVal flashInterval As Integer], _
    [ByVal symbol As Object] _
)

[C#]
public void FlashShape (
    IGeometry pShape,
    int nFlashes,
    int flashInterval,
    object symbol
);
[C#]

Optional Values

nFlashes   Supply 3 as a default value.
flashInterval   Supply 300 as a default value.
symbol   To indicate that this parameter is undefined, pass in Type.Missing. 
[C++]
HRESULT FlashShape(
  IGeometry* pShape,
  long nFlashes,
  long flashInterval,
  VARIANT symbol
);

[C++]

Parameters
pShape [in]

  pShape is a parameter of type IGeometry
nFlashes [in, optional, defaultvalue(3)]
  nFlashes is a parameter of type long
flashInterval [in, optional, defaultvalue(300)]
  flashInterval is a parameter of type long
symbol [optional]
  symbol is a parameter of type VARIANT

  To indicate this parameter is undefined pass in a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.

Product Availability

Available with ArcGIS Engine.

Description

FlashShape flashes the supplied geometry onto the display.

Errors Returned

1025 800a0401: The specified symbol does not indicate the correct type of object

1030 800a0406: The supplied geometry does not have a geometry type that is supported for drawing 

Remarks

Geometry objects implementing IEnvelope, IMultiPatch, IMultiPoint, IPoint, IPolygon and IPolyline are supported. 

See Also

IMapControl3 Interface | IMapControl3.DrawShape Method | IMapControl2.DrawShape Method | IMapControl4.DrawShape Method | IMapControl3.DrawText Method | IMapControl2.DrawText Method | IMapControl4.DrawText Method