ESRI.ArcGIS.ADF.Web.UI.WebControls
HeaderFormatString Property
See Also 
ESRI.ArcGIS.ADF.Web.UI.WebControls Namespace > MapTips Class : HeaderFormatString Property




The format string for the map tips header. Required property.

Syntax

Visual Basic (Declaration) 
<ObsoleteAttribute("Use the LayerFormat property")>
<ResCategoryAttribute("MapTips")>
<ResDescriptionAttribute("This property is no longer used.")>
<EditorAttribute(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="ESRI.ArcGIS.ADF.Web.UI.WebControls.Design.MapTipsExpressionEditor, ESRI.ArcGIS.ADF.Web.UI.WebControls, Version=10.0.0.0, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86")>
<PersistenceModeAttribute()>
<NotifyParentPropertyAttribute(True)>
<BrowsableAttribute(False)>
<DefaultValueAttribute()>
Public Property HeaderFormatString As String
Visual Basic (Usage)Copy Code
Dim instance As MapTips
Dim value As String
 
instance.HeaderFormatString = value
 
value = instance.HeaderFormatString
C# 
[ObsoleteAttribute("Use the LayerFormat property")]
[ResCategoryAttribute("MapTips")]
[ResDescriptionAttribute("This property is no longer used.")]
[EditorAttribute(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="ESRI.ArcGIS.ADF.Web.UI.WebControls.Design.MapTipsExpressionEditor, ESRI.ArcGIS.ADF.Web.UI.WebControls, Version=10.0.0.0, Culture=neutral, PublicKeyToken=8fc3cc631e44ad86")]
[PersistenceModeAttribute()]
[NotifyParentPropertyAttribute(true)]
[BrowsableAttribute(false)]
[DefaultValueAttribute()]
public string HeaderFormatString {get; set;}

Return Value

Format string for maptip header.

Remarks

When the user hovers over the maptip icon, a small popup window displays the information set in this property (along with the string "Click icon for more information").

This property is required. If not set, a runtime error will occur when the page attempts to display maptips.

If the user clicks the maptip icon, the maptip remains on the page until closed, and additional information is displayed as specified in the BodyFormatString property. The maptip may be moved around the page once it is clicked on.

The header content may include both attribute fields of the feature at the maptip location, as well as any other content added by the developer, including hyperlinks. Note that hyperlinks cannot be clicked on unless the user clicks the maptip icon to pin the maptip to the page; it may be preferable to add the hyperlink to the body via the BodyFormatString.

For more information on setting maptip content, see the MapTips control discussion in the Developer Help.

See Also

© 2010 All Rights Reserved.