Class ExtractPDFParams.Builder
Builds a ExtractPDFParams instance.
Inheritance
Namespace: Adobe.PDFServicesSDK.pdfjobs.parameters.extractpdf
Assembly: Adobe.PDFServicesSDK.Doc.dll
Syntax
public class BuilderConstructors
Builder()
Constructs a Builder instance.
Declaration
public Builder()Methods
AddCharInfo(Boolean)
Boolean specifying whether to add character level bounding boxes to output json
Declaration
public ExtractPDFParams.Builder AddCharInfo(bool addCharInfo)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | addCharInfo | Boolean |
Returns
| Type | Description |
|---|---|
| ExtractPDFParams.Builder | this Builder instance to add any additional parameters |
AddElementsToExtract(List<ExtractElementType>)
Adds elements to extract (Text and/or Tables) to the list of elements to be extracted.
Declaration
public ExtractPDFParams.Builder AddElementsToExtract(List<ExtractElementType> elementsToExtract)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<ExtractElementType> | elementsToExtract | elements parameters for extract operation |
Returns
| Type | Description |
|---|---|
| ExtractPDFParams.Builder | this Builder instance to add any additional parameters |
AddElementsToExtractRenditions(List<ExtractRenditionsElementType>)
Adds elements to extract (Figures and/or Tables) to the list of elements to be extracted.
Declaration
public ExtractPDFParams.Builder AddElementsToExtractRenditions(List<ExtractRenditionsElementType> elementsToExtractRenditions)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<ExtractRenditionsElementType> | elementsToExtractRenditions | the renditions parameters for extract operation |
Returns
| Type | Description |
|---|---|
| ExtractPDFParams.Builder | this Builder instance to add any additional parameters |
AddElementToExtract(ExtractElementType)
Adds an element to extract (Text or Tables).
Declaration
public ExtractPDFParams.Builder AddElementToExtract(ExtractElementType elementToExtract)Parameters
| Type | Name | Description |
|---|---|---|
| ExtractElementType | elementToExtract | element parameter for extract operation |
Returns
| Type | Description |
|---|---|
| ExtractPDFParams.Builder | this Builder instance to add any additional parameters |
AddElementToExtractRenditions(ExtractRenditionsElementType)
Adds a rendition to extract (Figures or Tables)
Declaration
public ExtractPDFParams.Builder AddElementToExtractRenditions(ExtractRenditionsElementType elementToExtractRenditions)Parameters
| Type | Name | Description |
|---|---|---|
| ExtractRenditionsElementType | elementToExtractRenditions | the rendition parameter for extract operation |
Returns
| Type | Description |
|---|---|
| ExtractPDFParams.Builder | this Builder instance to add any additional parameters |
AddGetStylingInfo(Boolean)
Boolean specifying whether to add styling information to output json
Declaration
public ExtractPDFParams.Builder AddGetStylingInfo(bool includeStyling)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | includeStyling | Boolean |
Returns
| Type | Description |
|---|---|
| ExtractPDFParams.Builder | this Builder instance to add any additional parameters |
AddTableStructureFormat(TableStructureType)
Adds the Table Structure format (Csv or Xlsx) for table renditions
Declaration
public ExtractPDFParams.Builder AddTableStructureFormat(TableStructureType tableStructureType)Parameters
| Type | Name | Description |
|---|---|---|
| TableStructureType | tableStructureType | parameter for output type of table structure |
Returns
| Type | Description |
|---|---|
| ExtractPDFParams.Builder | this Builder instance to add any additional parameters |
Build()
Returns a new ExtractPDFParams instance built from the current state of this builder.
Declaration
public ExtractPDFParams Build()Returns
| Type | Description |
|---|---|
| ExtractPDFParams | A new ExtractPDFParams instance |