Set alternative text for Image

The following code snippet also works with Aspose.PDF.Drawing library.

The XImage class contains GetAlternativeText and TrySetAlternativeText methods, which allow you to get and set the alternative text corresponding to an image.

The following code snippet shows you how to use these methods to set alternative text for an image in a PDF file and get it.

.NET Core 3.1

// For complete examples and data files, visit https://github.com/aspose-pdf/Aspose.PDF-for-.NET
private static void GetSetAlternativeTextForImage()
{
    // The path to the documents directory
    var dataDir = RunExamples.GetDataDir_AsposePdf_Images();

    // Open PDF document
    using (var document = new Aspose.Pdf.Document(dataDir + "SearchAndGetImages.pdf"))
    {
        // Alternative text to be given to the image 
        string altText = "Alternative text for image";

        // Image for which alternative text will be set and get
        XImage xImage = document.Pages[1].Resources.Images[1];

        // Try to set alternative text for an image
        bool result = xImage.TrySetAlternativeText(altText, document.Pages[1]);

        // If set is successful, then get the alternative text for the image
        if (result)
        {
            List<string> altTexts = xImage.GetAlternativeText(document.Pages[1]);
        }

        // Save PDF document
        document.Save(dataDir + "SearchAndGetImagesWithAltText_out.pdf");
    }
}

.NET 8

// For complete examples and data files, visit https://github.com/aspose-pdf/Aspose.PDF-for-.NET
private static void GetSetAlternativeTextForImage()
{
    // The path to the documents directory
    var dataDir = RunExamples.GetDataDir_AsposePdf_Images();

    // Open PDF document
    using var document = new Aspose.Pdf.Document(dataDir + "SearchAndGetImages.pdf");

    // Alternative text to be given to the image 
    string altText = "Alternative text for image";

    // Image for which alternative text will be set and get
    XImage xImage = document.Pages[1].Resources.Images[1];

    // Try to set alternative text for an image
    bool result = xImage.TrySetAlternativeText(altText, document.Pages[1]);

    // If set is successful, then get the alternative text for the image
    if (result)
    {
        List<string> altTexts = xImage.GetAlternativeText(document.Pages[1]);
    }

    // Save PDF document
    document.Save(dataDir + "SearchAndGetImagesWithAltText_out.pdf");    
}