ImageField.GetFormattedAlternateText Method (Control)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Applies the format specified by the DataAlternateTextFormatString property to the alternate text value contained in the specified Control object.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

protected virtual string GetFormattedAlternateText(
	Control controlContainer
)

Parameters

controlContainer
Type: System.Web.UI.Control

The Control that contains the alternate text value to transform.

Return Value

Type: System.String

The transformed value.

The GetFormattedAlternateText method is a helper method used by the ImageField class to apply the format specified by the DataImageUrlFormatString property to the alternate text value. The alternate text value is contained in the Control object specified by the controlContainer parameter.

Notes to Inheritors:

When extending the ImageField class, you can override this method to perform a custom formatting routine.

.NET Framework
Available since 2.0
Return to top
Show: