ImageField.GetFormattedAlternateText(Control) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

protected:
 virtual System::String ^ GetFormattedAlternateText(System::Web::UI::Control ^ controlContainer);

protected virtual string GetFormattedAlternateText (System.Web.UI.Control controlContainer);

abstract member GetFormattedAlternateText : System.Web.UI.Control -> string
override this.GetFormattedAlternateText : System.Web.UI.Control -> string

Protected Overridable Function GetFormattedAlternateText (controlContainer As Control) As String

Parameters

controlContainer: Control

The Control that contains the alternate text value to transform.

Returns

String

The transformed value.

Remarks

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.

Applies to