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


ISnappingEnvironment.SnapTipSymbol Property (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (Controls)  

ISnappingEnvironment.SnapTipSymbol Property

The symbol that displays the snap tip.

[Visual Basic .NET]
Public Property SnapTipSymbol As ITextSymbol

[C#]
public ITextSymbol SnapTipSymbol {get; set;}

[C++]
HRESULT get_SnapTipSymbol(
  ITextSymbol** symbol
);

[C++]
HRESULT putref_SnapTipSymbol(
  ITextSymbol* symbol
);

[C++]

Parameters
symbol [out, retval]

  symbol is a parameter of type ITextSymbol**
symbol [in]

  symbol is a parameter of type ITextSymbol*

Product Availability

Available with ArcGIS Engine.

Remarks

The SnapTipSymbol defines the textsymbol that is used to display information provided in the snap result�s description after a valid snap location was found.  If ISnappingEnvironment.SnapTipType=0 (no snap tip) this setting had no effect.


You have a number of options to customize the tip symbol, including advanced text capabilities provided by IFormattedTextSymbol to provide options for backgrounds, offsets, or right-to-left text capabilities. 
The location of the tip is not customizable; the application will display the snap tip above and to the right of the snap location, unless at the extreme top or right bounds of the display.
SnapTipSymbol is an application-level setting.

See Also

ISnappingEnvironment Interface