API Reference
PdfConversionProofOptions
Configures reusable proof checks for source-document to PDF conversion results.
Inheritance
- Object
- PdfConversionProofOptions
Usage
Explore 44 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 41
- Method PdfConversionProofOptions.AcceptWarningCodes
- Method PdfConversionProofOptions.RequireArtifactSha256
- Method PdfConversionProofOptions.RequireAttachmentFileNames
- Method PdfConversionProofOptions.RequireCatalogLanguage
- Method PdfConversionProofOptions.RequireCatalogPageLayout
- Method PdfConversionProofOptions.RequireCatalogPageMode
- Method PdfConversionProofOptions.RequireCatalogView
- Method PdfConversionProofOptions.RequireFormFieldNames
- Method PdfConversionProofOptions.RequireLinkUris
- Method PdfConversionProofOptions.RequireLogicalSignals
- Method PdfConversionProofOptions.RequireMetadata
- Method PdfConversionProofOptions.RequireNamedDestinationNames
- Method PdfConversionProofOptions.RequireNoErrors
- Method PdfConversionProofOptions.RequireNoLoss
- Method PdfConversionProofOptions.RequireNoUnexpectedWarningCodes
- Method PdfConversionProofOptions.RequireOpenAction
- Method PdfConversionProofOptions.RequireOptionalContentDefaultConfiguration
- Method PdfConversionProofOptions.RequireOptionalContentGroupCountAtLeast
- Method PdfConversionProofOptions.RequireOptionalContentGroupNames
- Method PdfConversionProofOptions.RequireOptionalContentHiddenGroupNames
- Method PdfConversionProofOptions.RequireOptionalContentLockedGroupNames
- Method PdfConversionProofOptions.RequireOptionalContentOrderedGroupNames
- Method PdfConversionProofOptions.RequireOptionalContentVisibleGroupNames
- Method PdfConversionProofOptions.RequireOutlineTitles
- Method PdfConversionProofOptions.RequireOutputConditionIdentifiers
- Method PdfConversionProofOptions.RequireOutputIntentSubtypes
- Method PdfConversionProofOptions.RequirePageCount
- Method PdfConversionProofOptions.RequirePageLabelRange
- Method PdfConversionProofOptions.RequirePageLabelRanges
- Method PdfConversionProofOptions.RequirePageSize
- Method PdfConversionProofOptions.RequireTaggedMarkedContentReferencesAtLeast
- Method PdfConversionProofOptions.RequireTaggedStructureElementCountAtLeast
- Method PdfConversionProofOptions.RequireTaggedStructureTypes
- Method PdfConversionProofOptions.RequireTextMarkers
- Method PdfConversionProofOptions.RequireViewerPreference
- Method PdfConversionProofOptions.RequireWarningCodes
- Method PdfConversionProofOptions.RequireWarningSources
- Method PdfConversionProofOptions.RequireXmpMetadata
- Method PdfConversionProofOptions.RequireXmpPdfAIdentification
- Method PdfConversionProofOptions.RequireXmpPdfUaIdentification
- Method PdfConversionProofOptions.RequireXmpSubjects
Accepted by parameters 3
Constructors
public PdfConversionProofOptions() #Methods
public PdfConversionProofOptions AcceptWarningCodes(params String[] codes) #PdfConversionProofOptionsAdds accepted warning codes and returns this options object for fluent setup.
Parameters
- codes System.String[]
public PdfConversionProofOptions RequireArtifactSha256(String sha256) #PdfConversionProofOptionsRequires the generated artifact SHA-256 to match the supplied hash.
Parameters
- sha256 System.String
public PdfConversionProofOptions RequireAttachmentFileNames(params String[] fileNames) #PdfConversionProofOptionsAdds required embedded or associated file names and returns this options object for fluent setup.
Parameters
- fileNames System.String[]
public PdfConversionProofOptions RequireCatalogLanguage(String language) #PdfConversionProofOptionsRequires the generated PDF catalog language to match the supplied value.
Parameters
- language System.String
public PdfConversionProofOptions RequireCatalogPageLayout(PdfCatalogPageLayout pageLayout) #PdfConversionProofOptionsRequires the generated PDF catalog page layout to match the supplied value.
Parameters
- pageLayout OfficeIMO.Pdf.PdfCatalogPageLayout
public PdfConversionProofOptions RequireCatalogPageMode(PdfCatalogPageMode pageMode) #PdfConversionProofOptionsRequires the generated PDF catalog page mode to match the supplied value.
Parameters
- pageMode OfficeIMO.Pdf.PdfCatalogPageMode
public PdfConversionProofOptions RequireCatalogView(PdfCatalogPageMode? pageMode = null, PdfCatalogPageLayout? pageLayout = null) #PdfConversionProofOptionsRequires the generated PDF catalog view hints to match the supplied values.
Parameters
- pageMode OfficeIMO.Pdf.PdfCatalogPageMode? = null
- pageLayout OfficeIMO.Pdf.PdfCatalogPageLayout? = null
public PdfConversionProofOptions RequireFormFieldNames(params String[] names) #PdfConversionProofOptionsAdds required AcroForm field names and returns this options object for fluent setup.
Parameters
- names System.String[]
public PdfConversionProofOptions RequireLinkUris(params String[] uris) #PdfConversionProofOptionsAdds required URI link targets and returns this options object for fluent setup.
Parameters
- uris System.String[]
public PdfConversionProofOptions RequireLogicalSignals(params String[] signals) #PdfConversionProofOptionsAdds required logical readback signals and returns this options object for fluent setup.
Parameters
- signals System.String[]
public PdfConversionProofOptions RequireMetadata(String? title = null, String? author = null, String? subject = null, String? keywords = null) #PdfConversionProofOptionsRequires selected PDF Info dictionary metadata values to match the generated PDF.
Parameters
- title System.String? = null
- author System.String? = null
- subject System.String? = null
- keywords System.String? = null
public PdfConversionProofOptions RequireNamedDestinationNames(params String[] names) #PdfConversionProofOptionsAdds required named destinations and returns this options object for fluent setup.
Parameters
- names System.String[]
public PdfConversionProofOptions RequireNoErrors() #PdfConversionProofOptionsRequires the conversion report to contain no error-severity warnings.
public PdfConversionProofOptions RequireNoLoss() #PdfConversionProofOptionsRequires every source and PDF conversion stage to report no possible content loss.
public PdfConversionProofOptions RequireNoUnexpectedWarningCodes() #PdfConversionProofOptionsRequires every conversion warning code to be explicitly accepted.
public PdfConversionProofOptions RequireOpenAction(Int32 pageNumber, PdfOpenActionDestinationMode? destinationMode = null) #PdfConversionProofOptionsRequires the generated PDF catalog open action to target the supplied page and optional destination mode.
Parameters
- pageNumber System.Int32
- destinationMode OfficeIMO.Pdf.PdfOpenActionDestinationMode? = null
public PdfConversionProofOptions RequireOptionalContentDefaultConfiguration(String? name = null, String? creator = null, String? baseState = null) #PdfConversionProofOptionsRequires selected optional-content default configuration values to match the generated PDF.
Parameters
- name System.String? = null
- creator System.String? = null
- baseState System.String? = null
public PdfConversionProofOptions RequireOptionalContentGroupCountAtLeast(Int32 count) #PdfConversionProofOptionsRequires at least the supplied number of optional-content/layer groups.
Parameters
- count System.Int32
public PdfConversionProofOptions RequireOptionalContentGroupNames(params String[] names) #PdfConversionProofOptionsAdds required optional-content/layer group names and returns this options object for fluent setup.
Parameters
- names System.String[]
public PdfConversionProofOptions RequireOptionalContentLockedGroupNames(params String[] names) #PdfConversionProofOptionsAdds optional-content/layer group names that must be locked in the default configuration.
Parameters
- names System.String[]
public PdfConversionProofOptions RequireOptionalContentOrderedGroupNames(params String[] names) #PdfConversionProofOptionsAdds optional-content/layer group names that must appear in the default configuration order.
Parameters
- names System.String[]
public PdfConversionProofOptions RequireOptionalContentVisibleGroupNames(params String[] names) #PdfConversionProofOptionsAdds optional-content/layer group names that must initially be visible.
Parameters
- names System.String[]
public PdfConversionProofOptions RequireOutlineTitles(params String[] titles) #PdfConversionProofOptionsAdds required outline/bookmark titles and returns this options object for fluent setup.
Parameters
- titles System.String[]
public PdfConversionProofOptions RequireOutputConditionIdentifiers(params String[] identifiers) #PdfConversionProofOptionsAdds required output condition identifiers and returns this options object for fluent setup.
Parameters
- identifiers System.String[]
public PdfConversionProofOptions RequireOutputIntentSubtypes(params String[] subtypes) #PdfConversionProofOptionsAdds required output intent subtypes and returns this options object for fluent setup.
Parameters
- subtypes System.String[]
public PdfConversionProofOptions RequirePageCount(Int32 pageCount) #PdfConversionProofOptionsRequires the generated PDF to contain exactly the supplied number of pages.
Parameters
- pageCount System.Int32
public PdfConversionProofOptions RequirePageLabelRange(Int32 startPageNumber, PdfPageNumberStyle style, Int32 startNumber = 1, String? prefix = null) #PdfConversionProofOptionsAdds a required page-label range and returns this options object for fluent setup.
Parameters
- startPageNumber System.Int32
- style OfficeIMO.Pdf.PdfPageNumberStyle
- startNumber System.Int32 = 1
- prefix System.String? = null
public PdfConversionProofOptions RequirePageLabelRanges(params PdfPageLabelRange[] ranges) #PdfConversionProofOptionsAdds required page-label ranges and returns this options object for fluent setup.
Parameters
- ranges OfficeIMO.Pdf.PdfPageLabelRange[]
public PdfConversionProofOptions RequirePageSize(Double width, Double height, Double tolerance = 0.01) #PdfConversionProofOptionsRequires every generated PDF page to match the supplied size in PDF points.
Parameters
- width System.Double
- height System.Double
- tolerance System.Double = 0.01
public PdfConversionProofOptions RequireTaggedMarkedContentReferencesAtLeast(Int32 count) #PdfConversionProofOptionsRequires at least the supplied number of tagged-PDF marked-content references.
Parameters
- count System.Int32
public PdfConversionProofOptions RequireTaggedStructureElementCountAtLeast(Int32 count) #PdfConversionProofOptionsRequires at least the supplied number of tagged-PDF structure elements.
Parameters
- count System.Int32
public PdfConversionProofOptions RequireTaggedStructureTypes(params String[] structureTypes) #PdfConversionProofOptionsAdds required tagged-PDF structure types and returns this options object for fluent setup.
Parameters
- structureTypes System.String[]
public PdfConversionProofOptions RequireTextMarkers(params String[] markers) #PdfConversionProofOptionsAdds required text markers and returns this options object for fluent setup.
Parameters
- markers System.String[]
public PdfConversionProofOptions RequireViewerPreference(String name, String value) #PdfConversionProofOptionsRequires a generated PDF catalog viewer preference value.
Parameters
- name System.String
- value System.String
public PdfConversionProofOptions RequireViewerPreference(String name, Boolean value) #PdfConversionProofOptionsRequires a generated PDF catalog viewer preference boolean value.
Parameters
- name System.String
- value System.Boolean
public PdfConversionProofOptions RequireWarningCodes(params String[] codes) #PdfConversionProofOptionsAdds required warning codes and returns this options object for fluent setup.
Parameters
- codes System.String[]
public PdfConversionProofOptions RequireWarningSources(params String[] sources) #PdfConversionProofOptionsAdds required warning sources and returns this options object for fluent setup.
Parameters
- sources System.String[]
public PdfConversionProofOptions RequireXmpMetadata(String? title = null, String? creator = null, String? description = null, String? producer = null, String? keywords = null) #PdfConversionProofOptionsRequires selected XMP metadata values to match the generated PDF catalog metadata stream.
Parameters
- title System.String? = null
- creator System.String? = null
- description System.String? = null
- producer System.String? = null
- keywords System.String? = null
public PdfConversionProofOptions RequireXmpPdfAIdentification(Int32 part, String? conformance = null) #PdfConversionProofOptionsRequires XMP PDF/A identification metadata to match the generated PDF.
Parameters
- part System.Int32
- conformance System.String? = null
public PdfConversionProofOptions RequireXmpPdfUaIdentification(Int32 part = 1) #PdfConversionProofOptionsRequires XMP PDF/UA identification metadata to match the generated PDF.
Parameters
- part System.Int32 = 1
public PdfConversionProofOptions RequireXmpSubjects(params String[] subjects) #PdfConversionProofOptionsAdds required XMP subject values and returns this options object for fluent setup.
Parameters
- subjects System.String[]
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Boolean RequireReadablePdf { get; set; } #True when the generated PDF must be readable by the OfficeIMO.Pdf reader.
public Boolean RequireNoErrorWarnings { get; set; } #True when error-severity conversion warnings should fail the proof.
public Boolean RequireNoUnexpectedWarnings { get; set; } #True when conversion warnings whose codes are not accepted should fail the proof.
public Boolean RequireLosslessConversion { get; set; } #True when possible content loss in any conversion stage should fail the proof.
public Boolean IncludeArtifactHash { get; set; } #True when the proof snapshot should include the generated artifact byte count and SHA-256.
public String? RequiredArtifactSha256 { get; set; } #Expected SHA-256 hash for the generated artifact.
public Int32? RequiredPageCount { get; set; } #Expected page count for the generated PDF artifact.
public Double? RequiredPageWidth { get; set; } #Expected page width in PDF points for every generated page.
public Double? RequiredPageHeight { get; set; } #Expected page height in PDF points for every generated page.
public Double RequiredPageSizeTolerance { get; set; } #Allowed point difference when comparing required page size.
public String? RequiredMetadataTitle { get; set; } #Expected PDF Info dictionary title.
public String? RequiredMetadataAuthor { get; set; } #Expected PDF Info dictionary author.
public String? RequiredMetadataSubject { get; set; } #Expected PDF Info dictionary subject.
public String? RequiredMetadataKeywords { get; set; } #Expected PDF Info dictionary keywords.
public String? RequiredCatalogLanguage { get; set; } #Expected catalog language value.
public String? RequiredCatalogPageMode { get; set; } #Expected catalog page mode PDF name.
public String? RequiredCatalogPageLayout { get; set; } #Expected catalog page layout PDF name.
public Int32? RequiredOpenActionPageNumber { get; set; } #Expected one-based document open-action target page number.
public PdfOpenActionDestinationMode? RequiredOpenActionDestinationMode { get; set; } #Expected document open-action destination mode.
public String? RequiredOptionalContentDefaultConfigurationName { get; set; } #Expected optional-content default configuration name.
public String? RequiredOptionalContentDefaultConfigurationCreator { get; set; } #Expected optional-content default configuration creator.
public String? RequiredOptionalContentBaseState { get; set; } #Expected optional-content default configuration base state.
public Int32? RequiredOptionalContentGroupCountAtLeast { get; set; } #Minimum optional-content group count required in the generated PDF.
public String? RequiredXmpTitle { get; set; } #Expected XMP Dublin Core title.
public String? RequiredXmpCreator { get; set; } #Expected XMP Dublin Core creator.
public String? RequiredXmpDescription { get; set; } #Expected XMP Dublin Core description.
public String? RequiredXmpProducer { get; set; } #Expected XMP PDF producer metadata.
public String? RequiredXmpKeywords { get; set; } #Expected XMP PDF keywords metadata.
public Int32? RequiredXmpPdfAPart { get; set; } #Expected XMP PDF/A identification part.
public String? RequiredXmpPdfAConformance { get; set; } #Expected XMP PDF/A identification conformance.
public Int32? RequiredXmpPdfUaPart { get; set; } #Expected XMP PDF/UA identification part.
public Int32? RequiredTaggedStructureElementCountAtLeast { get; set; } #Minimum tagged-PDF structure element count required in the generated PDF.
public Int32? RequiredTaggedMarkedContentReferencesAtLeast { get; set; } #Minimum tagged-PDF marked-content reference count required in the generated PDF.
public IList<String> RequiredTextMarkers { get; } #Text markers that must be extractable from the generated PDF.
public IList<String> RequiredLogicalSignals { get; } #Logical readback signals that must be present in the generated PDF.
public IList<String> RequiredOutlineTitles { get; } #PDF outline/bookmark titles that must be present in the generated PDF.
public IList<String> RequiredLinkUris { get; } #URI link targets that must be present in the generated PDF.
public IList<String> RequiredFormFieldNames { get; } #AcroForm field names that must be present in the generated PDF.
public IList<String> RequiredNamedDestinationNames { get; } #Named destinations that must be present in the generated PDF catalog.
public IList<PdfPageLabelRange> RequiredPageLabelRanges { get; } #Page-label ranges that must be present in the generated PDF catalog.
public IList<String> RequiredAttachmentFileNames { get; } #Embedded or associated file names that must be present in the generated PDF catalog.
public IList<String> RequiredOutputIntentSubtypes { get; } #Output intent subtypes that must be present in the generated PDF catalog.
public IList<String> RequiredOutputConditionIdentifiers { get; } #Output condition identifiers that must be present in the generated PDF catalog.
public IList<String> RequiredOptionalContentGroupNames { get; } #Optional-content/layer group names that must be present in the generated PDF catalog.
public IList<String> RequiredOptionalContentVisibleGroupNames { get; } #Optional-content/layer group names that must initially be visible.
public IList<String> RequiredOptionalContentLockedGroupNames { get; } #Optional-content/layer group names that must be locked in the default configuration.
public IList<String> RequiredOptionalContentOrderedGroupNames { get; } #Optional-content/layer group names that must appear in the default configuration order.
public IList<String> RequiredXmpSubjects { get; } #XMP Dublin Core subjects that must be present in the generated PDF catalog metadata.
public IList<String> RequiredTaggedStructureTypes { get; } #Tagged-PDF structure types that must be present in the generated PDF structure tree.
public IDictionary<String, String> RequiredViewerPreferences { get; } #Viewer preference values that must be present in the generated PDF catalog.
public IList<String> RequiredWarningCodes { get; } #Stable warning codes that must be present in the captured conversion report.
public IList<String> RequiredWarningSources { get; } #Warning source labels that must be present in the captured conversion report.
public ISet<String> AcceptedWarningCodes { get; } #Stable warning codes accepted by this proof contract when unexpected warnings are rejected.