API Reference
PdfCanvasStructureOptions
Optional accessibility attributes for a canvas structure container.
Inheritance
- Object
- PdfCanvasStructureOptions
Usage
Explore 2 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 1
Accepted by parameters 1
- Method PdfPageCanvas.Structure
Constructors
public PdfCanvasStructureOptions() #Methods
public PdfCanvasStructureOptions AddAssociatedFile(PdfEmbeddedFile file) #PdfCanvasStructureOptionsAssociates a snapshot of an embedded file with this structure element.
Parameters
- file OfficeIMO.Pdf.PdfEmbeddedFile
Exceptions
InvalidDataException– The payload or projected structure collection exceeds its configured byte limit.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public PdfListNumbering? ListNumbering { get; set; } #Semantic label style for a List container. Null leaves the attribute unspecified.
public String? AlternativeText { get; set; } #Alternative text associated with the structure container.
public String? Language { get; set; } #Optional language tag for this structure and its descendants, for example "fr-FR". Null inherits the parent language.
public PdfCanvasTableHeaderScope? HeaderScope { get; set; } #Row, column, or combined scope for a table-header cell.
public Int32 ColumnSpan { get; set; } #Number of table columns occupied by a tagged cell.
public Int32 RowSpan { get; set; } #Number of table rows occupied by a tagged cell.
public Int64 MaxAssociatedFileBytes { get; set; } #Maximum payload bytes in each file admitted to this structure element. Defaults to 128 MiB.
public Int64 MaxTotalAssociatedFileBytes { get; set; } #Maximum aggregate payload bytes admitted to this structure element. Defaults to 256 MiB.
public IReadOnlyList<PdfEmbeddedFile> AssociatedFiles { get; } #Files associated with this structure element. Returned descriptions and payloads are independent copies.