Class AutotagPDFJob

A job that creates PDF documents with enhanced readability from existing PDF documents. An optional tagging report can also be generated which contains the information about the tags that the tagged output PDF document contains. Accessibility tags, used by assistive technology such as screen reader are required to make PDF files compliant. However, the generated PDF is not guaranteed to comply with accessibility standards such as WCAG and PDF/UA as there could be a need to perform further downstream remediation to meet those standards.

Inheritance

System.Object

PDFServicesJob

AutotagPDFJob

Namespace: Adobe.PDFServicesSDK.pdfjobs.jobs

Assembly: Adobe.PDFServicesSDK.Doc.dll

Syntax

public class AutotagPDFJob : PDFServicesJob

Examples

Sample Usage:

    using Stream inputStream = File.OpenRead("<SOURCE_PATH>");

    ICredentials credentials = new ServicePrincipalCredentials(
        Environment.GetEnvironmentVariable("PDF_SERVICES_CLIENT_ID"),
        Environment.GetEnvironmentVariable("PDF_SERVICES_CLIENT_SECRET"));

    PDFServices pdfServices = new PDFServices(credentials);

    IAsset asset = pdfServices.Upload(inputStream, PDFServicesMediaType.PDF.GetMIMETypeValue());
    AutotagPDFJob autotagPDFJob = new AutotagPDFJob(asset);
    String location = pdfServices.Submit(autotagPDFJob);
    PDFServicesResponse<AutotagPDFResult> pdfServicesResponse =
        pdfServices.GetJobResult<AutotagPDFResult>(location, typeof(AutotagPDFResult));

    IAsset resultAsset = pdfServicesResponse.Result.TaggedPDF;
    StreamAsset streamAsset = pdfServices.GetContent(resultAsset);

Constructors

AutotagPDFJob(IAsset)

Constructs a new AutotagPDFJob instance.

Declaration

public AutotagPDFJob(IAsset asset)

Parameters

Type	Name	Description
IAsset	asset	The input IAsset for the job; can not be null.

Methods

SetOutput(IAsset)

Sets the output asset for the job.

Declaration

public AutotagPDFJob SetOutput(IAsset asset)

Parameters

Type	Name	Description
IAsset	asset	IAsset object representing the output asset; can not be null.

Returns

Type	Description
AutotagPDFJob	AutotagPDFJob instance

Remarks

External assets can be set as output only when input is external asset as well

SetParams(AutotagPDFParams)

Sets the parameters for the job.

Declaration

public AutotagPDFJob SetParams(AutotagPDFParams autotagPDFParams)

Parameters

Type	Name	Description
AutotagPDFParams	autotagPDFParams	AutotagPDFParams for the job.

Returns

Type	Description
AutotagPDFJob	AutotagPDFJob instance