-
Classes
- AcroForm
- ActionBase
- ActionFieldsBase
- ActionGoTo
- ActionGoToR
- ActionHide
- ActionImportData
- ActionJavaScript
- ActionJavaScriptMap
- ActionLaunch
- ActionLaunchWinAttrs
- ActionNamed
- ActionResetForm
- ActionSound
- ActionSubmitForm
- ActionUnknown
- ActionUri
- AnnotationBase
- AnnotationCollection
- AnnotationPagesCollection
- AppearanceStream
- AppearanceStreams
- AssociatedFiles
- Attr
- AttrClsRevision
- AttrClsRevisionCollection
- AttrCollection
- AttrRevision
- AttrRevisionCollection
- BilevelBitmap
- Bitmap
- BmpContext
- Border
- BorderEffect
- Brush
- ButtonAppearance
- CaretAnnotation
- CheckBoxField
- ChoiceField
- CircleAnnotation
- ClassMap
- ComboBoxField
- CombTextField
- ContentItemLink
- ContentItemLinkCollection
- DefaultAppearance
- Destination
- DestinationBase
- DestinationFit
- DestinationFitB
- DestinationFitBh
- DestinationFitBv
- DestinationFitH
- DestinationFitR
- DestinationFitV
- DestinationRef
- DestinationUnknown
- DestinationXyz
- DocAction
- DocumentDestinations
- DocumentInfo
- DocumentSecurityStore
- DrawingContext
- DsPdf
- DsPdfConfig
- EmbeddedFileStream
- Field
- FieldCollection
- FieldWidgetCollection
- FileAttachmentAnnotation
- FileInfo
- FileSpecification
- FileSpecificationMap
- Font
- FontCollection
- FontHandler
- FontHandlerCollection
- Format
- FormXObject
- FreeTextAnnotation
- GraphicsPath
- GrayscaleBitmap
- HatchBrush
- IccProfile
- Image
- ImageBrush
- InkAnnotation
- Layout
- LineAnnotation
- LinearGradientBrush
- LinkAnnotation
- ListBoxField
- MarkInfo
- MarkupAnnotation
- McidContentItemLink
- McrContentItemLink
- Metadata
- Model3DAnnotation
- Model3DStream
- Model3DView
- Model3DViewCollection
- Namespace
- NamespaceCollection
- ObjectBase
- ObjectManager
- ObjrContentItemLink
- OutlineNode
- OutlineNodeCollection
- OutputIntent
- OutputIntentCollection
- PageLabelingRange
- PageLabelingRangeMap
- PdfCidFont
- PdfCidFontType0
- PdfCidFontType2
- PdfCidFontUnknown
- PdfCMapTable
- PdfContext
- PdfDocument
- PdfFont
- PdfFontDescriptor
- PdfFontSimple
- PdfFontTrueType
- PdfFontType0
- PdfFontType1
- PdfFontType3
- PdfImageHandler
- PdfImageHandlerCollection
- PdfPage
- PdfPageCollection
- PdfSignature
- Pen
- Pkcs7Signer
- Pkcs7SignerBase
- PolygonAnnotation
- PolygonAnnotationBase
- PolyLineAnnotation
- PopupAnnotation
- PushButtonField
- RadialGradientBrush
- RadioButtonField
- RContentItemLink
- RedactAnnotation
- RichMediaAnnotation
- RoleMap
- Security
- SecurityHandlerBase
- SignatureField
- SolidBrush
- SoundAnnotation
- SoundObject
- SplitOptions
- SquareAnnotation
- StampAnnotation
- StandardSecurityHandler
- StandardSecurityHandlerRev2
- StandardSecurityHandlerRev3
- StandardSecurityHandlerRev4
- StandardSecurityHandlerRev5
- StandardSecurityHandlerRev6
- StructElement
- StructElementCollection
- StructTreeItem
- StructTreeItemCollection
- StructTreeRoot
- SvgContext
- SvgDocument
- TextAnnotation
- TextField
- TextMarkupAnnotation
- TimeStamper
- TimeStampProvider
- Transform
- UnknownAnnotation
- UnknownSecurityHandler
- WatermarkAnnotation
- WidgetAnnotation
- Enumerations
- Functions
- Interfaces
- README
- Index
- TypeAliases
- Variables
StructElement
Class: StructElement
Represents a PDF tag (structure element) in a document's structure tree.
Extends
Constructors
Constructor
new StructElement(type?): StructElement;
Creates a new StructElement object.
Parameters
type?
string
The element's structure type.
Returns
StructElement
Overrides
StructTreeItem.constructor
Constructor
new StructElement(om, type?): StructElement;
Creates a new StructElement object.
Parameters
om
An object manager that controls the lifetime of the StructElement object.
type?
string
The element's structure type.
Returns
StructElement
Overrides
StructTreeItem.constructor
Accessors
actualText
Get Signature
get actualText(): string;
Gets a text that is an exact replacement for the structure element and its children.
Returns
string
Set Signature
set actualText(value): void;
Sets a text that is an exact replacement for the structure element and its children.
Parameters
value
string
Returns
void
alternateDescription
Get Signature
get alternateDescription(): string;
Gets the alternate description of the structure element and its children in human-readable form.
Returns
string
Set Signature
set alternateDescription(value): void;
Sets the alternate description of the structure element and its children in human-readable form.
Parameters
value
string
Returns
void
associatedFiles
Get Signature
get associatedFiles(): AssociatedFiles;
Gets the list of embedded files associated with this StructElement.
Returns
attrClasses
Get Signature
get attrClasses(): AttrClsRevisionCollection;
Gets the collection of attribute classes associated with this structure element.
Returns
attrs
Get Signature
get attrs(): AttrRevisionCollection;
Gets the collection of attributes associated with this structure element.
Returns
children
Get Signature
get children(): StructElementCollection;
Gets the collection of child StructElement objects (a view over StructElement#items).
Returns
contentItems
Get Signature
get contentItems(): ContentItemLinkCollection;
Gets the collection of ContentItemLink objects (a view over StructElement#items).
Returns
defaultPage
Get Signature
get defaultPage(): PdfPage;
Gets the PdfPage object used as the default page for the content items owned by this StructElement.
Returns
Set Signature
set defaultPage(value): void;
Sets the PdfPage object used as the default page for the content items owned by this StructElement.
Parameters
value
Returns
void
elementId
Get Signature
get elementId(): string;
Gets the element identifier designating this structure element. The value must be unique
among all elements in the document's structure hierarchy.
(Named elementId to avoid clashing with ObjectBase#id.)
Returns
string
Set Signature
set elementId(value): void;
Sets the element identifier designating this structure element. The value must be unique
among all elements in the document's structure hierarchy.
(Named elementId to avoid clashing with ObjectBase#id.)
Parameters
value
string
Returns
void
expandedAbbreviation
Get Signature
get expandedAbbreviation(): string;
Gets the expanded form of an abbreviation.
Returns
string
Set Signature
set expandedAbbreviation(value): void;
Sets the expanded form of an abbreviation.
Parameters
value
string
Returns
void
hasAssociatedFiles
Get Signature
get hasAssociatedFiles(): boolean;
Gets a value indicating whether the StructElement#associatedFiles collection contains any items.
Returns
boolean
hasAttrClasses
Get Signature
get hasAttrClasses(): boolean;
Gets a value indicating whether the StructElement#attrClasses collection contains any items.
Returns
boolean
hasAttrs
Get Signature
get hasAttrs(): boolean;
Gets a value indicating whether the StructElement#attrs collection contains any items.
Returns
boolean
hasItems
Get Signature
get hasItems(): boolean;
Gets a value indicating whether the StructElement#items collection contains any items.
Returns
boolean
id
Get Signature
get id(): number;
Gets the reference to the object.
Returns
number
Inherited from
items
Get Signature
get items(): StructTreeItemCollection;
Gets the collection of nested StructTreeItem objects.
Returns
ns
Get Signature
get ns(): Namespace;
Gets the Namespace object defining the namespace this element belongs to.
Returns
Set Signature
set ns(value): void;
Sets the Namespace object defining the namespace this element belongs to.
Parameters
value
Returns
void
om
Get Signature
get om(): ObjectManager;
Gets the owner ObjectManager instance.
Returns
Inherited from
parent
Get Signature
get parent(): StructElement;
Gets the parent StructElement object, or null if there is none.
Returns
StructElement
title
Get Signature
get title(): string;
Gets the title of the structure element, a text string representing it in human-readable form.
Returns
string
Set Signature
set title(value): void;
Sets the title of the structure element, a text string representing it in human-readable form.
Parameters
value
string
Returns
void
type
Get Signature
get type(): string;
Gets the structure type, a string identifying the nature of the structure element and its role within the document, such as chapter, paragraph, or footnote.
Returns
string
Set Signature
set type(value): void;
Sets the structure type, a string identifying the nature of the structure element and its role within the document, such as chapter, paragraph, or footnote.
Parameters
value
string
Returns
void
Methods
free()
free(): void;
Detaches the object from the ObjectManager and deallocates its memory, if possible.
Returns
void
Inherited from
rebind()
rebind(omTo): void;
Rebinds the object from the current ObjectManager to the specified one.
Parameters
omTo
The new ObjectManager for the object.
Returns
void