Share via


SummaryLink.ImageUrlAltText Property

Gets or sets the text associated with the image URL for this SummaryLink object.

Namespace:  Microsoft.SharePoint.Publishing
Assembly:  Microsoft.SharePoint.Publishing (in Microsoft.SharePoint.Publishing.dll)

Syntax

'Declaration
Public Property ImageUrlAltText As String
    Get
    Set
'Usage
Dim instance As SummaryLink
Dim value As String

value = instance.ImageUrlAltText

instance.ImageUrlAltText = value
public string ImageUrlAltText { get; set; }

Property Value

Type: System.String
The text associated with the image URL for this SummaryLink object.

Exceptions

Exception Condition
ArgumentException

Invalid property value. The value cannot exceed 500 characters.

Remarks

The alternate text can be used in HTML rendering as an alt attribute of a <SRC> tag that renders the ImageUrl property. This provides a tooltip in some browsers that describes the image. This value is available in the XSL rendering through the @ImageUrlAltText parameter. When setting the value, the input is first stripped of leading and trailing whitespace before being applied.

This property typically renders as the alt attribute on an <IMG> tag.

See Also

Reference

SummaryLink Class

SummaryLink Members

Microsoft.SharePoint.Publishing Namespace

ImageUrl

SummaryLink