Aspose::Pdf::XImage::TrySetAlternativeText method
Contents
[
Hide
]XImage::TrySetAlternativeText method
Sets alternative text for an XImage on the page.
bool Aspose::Pdf::XImage::TrySetAlternativeText(const System::String &alternativeText, const System::SharedPtr<Aspose::Pdf::Page> &page)
| Parameter | Type | Description |
|---|---|---|
| alternativeText | const System::String& | The alternative text to be specified. |
| page | const System::SharedPtr<Aspose::Pdf::Page>& | Page where XImage is located. |
ReturnValue
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
- Class String
- Typedef SharedPtr
- Class Page
- Class XImage
- Namespace Aspose::Pdf
- Library Aspose.PDF for C++
