XImage.TrySetAlternativeText

XImage.TrySetAlternativeText method

Sets alternative text for an XImage on the page.

public bool TrySetAlternativeText(string alternativeText, Page page)
ParameterTypeDescription
alternativeTextStringThe alternative text to be specified.
pagePagePage where XImage is located.

Return Value

True if alternativeText for XImage is set. False if alternativeText for XImage not set.

Remarks

The method returns false in the following cases: - The XImage is not found on the specified page. - The XImage appears multiple times on the page with different structural elements, making it ambiguous which instance should receive the alternative text.

See Also