Represents Standard Structure Types. More...
Inherits System::Object.
Public Member Functions | |
System::String | get_Tag () const |
Gets tag name of Aspose::Pdf::LogicalStructure::StructureElement. More... | |
System::SharedPtr< StructureTypeCategory > | get_Category () const |
Gets category of Standard Structure Type. More... | |
virtual System::String | ToString () |
Returns a string that represents the current object. More... | |
![]() | |
ASPOSECPP_SHARED_API | Object () |
Creates object. Initializes all internal data structures. More... | |
virtual ASPOSECPP_SHARED_API | ~Object () |
Destroys object. Frees all internal data structures. More... | |
ASPOSECPP_SHARED_API | Object (Object const &x) |
Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More... | |
Object & | operator= (Object const &x) |
Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More... | |
Object * | SharedRefAdded () |
Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
int | SharedRefRemovedSafe () |
Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
int | RemovedSharedRefs (int count) |
Decreases shared reference count by specified value. More... | |
Detail::SmartPtrCounter * | WeakRefAdded () |
Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
void | WeakRefRemoved () |
Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
Detail::SmartPtrCounter * | GetCounter () |
Gets reference counter data structure associated with the object. More... | |
int | SharedCount () const |
Gets current value of shared refernce counter. More... | |
ASPOSECPP_SHARED_API void | Lock () |
Implements C# lock() statement locking. Call directly or use LockContext sentry object. More... | |
ASPOSECPP_SHARED_API void | Unlock () |
Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More... | |
virtual ASPOSECPP_SHARED_API bool | Equals (ptr obj) |
Compares objects using C# Object.Equals semantics. More... | |
virtual ASPOSECPP_SHARED_API int | GetHashCode () const |
Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More... | |
virtual ASPOSECPP_SHARED_API String | ToString () const |
Analog of C# Object.ToString() method. Enables converting custom objects to string. More... | |
virtual ASPOSECPP_SHARED_API ptr | MemberwiseClone () const |
Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More... | |
virtual ASPOSECPP_SHARED_API const TypeInfo & | GetType () const |
Gets actual type of object. Analog of C# System.Object.GetType() call. More... | |
virtual ASPOSECPP_SHARED_API bool | Is (const TypeInfo &targetType) const |
Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More... | |
virtual ASPOSECPP_SHARED_API void | SetTemplateWeakPtr (unsigned int argument) |
Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More... | |
template<> | |
bool | Equals (float const &objA, float const &objB) |
template<> | |
bool | Equals (double const &objA, double const &objB) |
template<> | |
bool | ReferenceEquals (String const &str, std::nullptr_t) |
template<> | |
bool | ReferenceEquals (String const &str1, String const &str2) |
Static Public Member Functions | |
static System::SharedPtr< StructureTypeStandard > | to_StructureTypeStandard (System::String tag) |
![]() | |
static bool | ReferenceEquals (ptr const &objA, ptr const &objB) |
Compares objects by reference. More... | |
template<typename T > | |
static std::enable_if<!IsSmartPtr< T >::value, bool >::type | ReferenceEquals (T const &objA, T const &objB) |
Compares objects by reference. More... | |
template<typename T > | |
static std::enable_if<!IsSmartPtr< T >::value, bool >::type | ReferenceEquals (T const &objA, std::nullptr_t) |
Reference-compares value type object with nullptr. More... | |
template<typename T1 , typename T2 > | |
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type | Equals (T1 const &objA, T2 const &objB) |
Compares reference type objects in C# style. More... | |
template<typename T1 , typename T2 > | |
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type | Equals (T1 const &objA, T2 const &objB) |
Compares value type objects in C# style. More... | |
static const TypeInfo & | Type () |
Impleemnts C# typeof(System.Object) construct. More... | |
Static Public Attributes | |
static System::SharedPtr< StructureTypeStandard > | Document |
(Document) A complete document. This is the root element of any structure tree containing multiple parts or multiple articles. More... | |
static System::SharedPtr< StructureTypeStandard > | Part |
(Part) A large-scale division of a document. This type of element is appropriate for grouping articles or sections. More... | |
static System::SharedPtr< StructureTypeStandard > | Art |
(Article) A relatively self-contained body of text constituting a single narrative or exposition. Articles should be disjoint; that is, they should not contain other articles as constituent elements. More... | |
static System::SharedPtr< StructureTypeStandard > | Sect |
(Section) A container for grouping related content elements. More... | |
static System::SharedPtr< StructureTypeStandard > | Div |
(Division) A generic block-level element or group of elements. More... | |
static System::SharedPtr< StructureTypeStandard > | BlockQuote |
(Block quotation) A portion of text consisting of one or more paragraphs attributed to someone other than the author of the surrounding text. More... | |
static System::SharedPtr< StructureTypeStandard > | Caption |
(Caption) A brief portion of text describing a table or figure. More... | |
static System::SharedPtr< StructureTypeStandard > | TOC |
static System::SharedPtr< StructureTypeStandard > | TOCI |
static System::SharedPtr< StructureTypeStandard > | Index |
(Index) A sequence of entries containing identifying text accompanied by reference elements that point out occurrences of the specified text in the main body of a document. More... | |
static System::SharedPtr< StructureTypeStandard > | NonStruct |
(Nonstructural element) A grouping element having no inherent structural significance; it serves solely for grouping purposes. This type of element differs from a division (structure type Div) in that it shall not be interpreted or exported to other document formats; however, its descendants shall be processed normally. More... | |
static System::SharedPtr< StructureTypeStandard > | Private |
(Private element) A grouping element containing private content belonging to the application producing it. The structural significance of this type of element is unspecified and shall be determined entirely by the conforming writer. Neither the Private element nor any of its descendants shall be interpreted or exported to other document formats. More... | |
static System::SharedPtr< StructureTypeStandard > | P |
(Paragraph) A low-level division of text. More... | |
static System::SharedPtr< StructureTypeStandard > | H |
(Heading) A label for a subdivision of a document's content. It should be the first child of the division that it heads. More... | |
static System::SharedPtr< StructureTypeStandard > | H1 |
Level 1 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting. More... | |
static System::SharedPtr< StructureTypeStandard > | H2 |
Level 2 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting. More... | |
static System::SharedPtr< StructureTypeStandard > | H3 |
Level 3 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting. More... | |
static System::SharedPtr< StructureTypeStandard > | H4 |
Level 4 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting. More... | |
static System::SharedPtr< StructureTypeStandard > | H5 |
Level 5 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting. More... | |
static System::SharedPtr< StructureTypeStandard > | H6 |
Level 6 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting. More... | |
static System::SharedPtr< StructureTypeStandard > | L |
(List) A sequence of items of like meaning and importance. Its immediate children should be an optional caption (structure type Caption) followed by one or more list items (structure type LI). More... | |
static System::SharedPtr< StructureTypeStandard > | LI |
(List item) An individual member of a list. Its children may be one or more labels, list bodies, or both (structure types Lbl or LBody). More... | |
static System::SharedPtr< StructureTypeStandard > | Lbl |
(Label) A name or number that distinguishes a given item from others in the same list or other group of like items. More... | |
static System::SharedPtr< StructureTypeStandard > | LBody |
(List body) The descriptive content of a list item. In a dictionary list, for example, it contains the definition of the term. It may either contain the content directly or have other BLSEs, perhaps including nested lists, as children. More... | |
static System::SharedPtr< StructureTypeStandard > | Table |
(Table) A two-dimensional layout of rectangular data cells, possibly having a complex substructure. It contains either one or more table rows (structure type TR) as children; or an optional table head (structure type THead) followed by one or more table body elements (structure type TBody) and an optional table footer (structure type TFoot). In addition, a table may have a caption (structure type Caption) as its first or last child. More... | |
static System::SharedPtr< StructureTypeStandard > | THead |
(Table header row group; PDF 1.5) A group of rows that constitute the header of a table. If the table is split across multiple pages, these rows may be redrawn at the top of each table fragment (although there is only one THead element). More... | |
static System::SharedPtr< StructureTypeStandard > | TBody |
(Table body row group; PDF 1.5) A group of rows that constitute the main body portion of a table. If the table is split across multiple pages, the body area may be broken apart on a row boundary. A table may have multiple TBody elements to allow for the drawing of a border or background for a set of rows. More... | |
static System::SharedPtr< StructureTypeStandard > | TFoot |
(Table footer row group; PDF 1.5) A group of rows that constitute the footer of a table. If the table is split across multiple pages, these rows may be redrawn at the bottom of each table fragment (although there is only one TFoot element.) More... | |
static System::SharedPtr< StructureTypeStandard > | TR |
(Table row) A row of headings or data in a table. It may contain table header cells and table data cells (structure types TH and TD). More... | |
static System::SharedPtr< StructureTypeStandard > | TH |
(Table header cell) A table cell containing header text describing one or more rows or columns of the table. More... | |
static System::SharedPtr< StructureTypeStandard > | TD |
(Table data cell) A table cell containing data that is part of the table's content. More... | |
static System::SharedPtr< StructureTypeStandard > | Span |
(Span) A generic inline portion of text having no particular inherent characteristics. It can be used, for example, to delimit a range of text with a given set of styling attributes. More... | |
static System::SharedPtr< StructureTypeStandard > | Quote |
static System::SharedPtr< StructureTypeStandard > | Note |
static System::SharedPtr< StructureTypeStandard > | Reference |
(Reference) A citation to content elsewhere in the document. More... | |
static System::SharedPtr< StructureTypeStandard > | BibEntry |
static System::SharedPtr< StructureTypeStandard > | Code |
(Code) A fragment of computer program text. More... | |
static System::SharedPtr< StructureTypeStandard > | Link |
(Link) An association between a portion of the ILSE's content and a corresponding link annotation or annotations. Its children should be one or more content items or child ILSEs and one or more object references identifying the associated link annotations. More... | |
static System::SharedPtr< StructureTypeStandard > | Annot |
(Annotation; PDF 1.5) An association between a portion of the ILSE's content and a corresponding PDF annotation. Annot shall be used for all PDF annotations except link annotations and widget annotations. More... | |
static System::SharedPtr< StructureTypeStandard > | Ruby |
static System::SharedPtr< StructureTypeStandard > | RB |
(Ruby base text) The full-size text to which the ruby annotation is applied. RB may contain text, other inline elements, or a mixture of both. It may have the RubyAlignattribute. More... | |
static System::SharedPtr< StructureTypeStandard > | RT |
(Ruby annotation text) The smaller-size text that shall be placed adjacent to the ruby base text. It may contain text, other inline elements, or a mixture of both. It may have the RubyAlign and RubyPosition attributes. More... | |
static System::SharedPtr< StructureTypeStandard > | RP |
(Ruby punctuation) Punctuation surrounding the ruby annotation text. It is used only when a ruby annotation cannot be properly formatted in a ruby style and instead is formatted as a normal comment, or when it is formatted as a warichu. It contains text (usually a single LEFT or RIGHT PARENTHESIS or similar bracketing character). More... | |
static System::SharedPtr< StructureTypeStandard > | Warichu |
static System::SharedPtr< StructureTypeStandard > | WT |
(Warichu text) The smaller-size text of a warichu comment that is formatted into two lines and placed between surrounding WP elements. More... | |
static System::SharedPtr< StructureTypeStandard > | WP |
(Warichu punctuation) The punctuation that surrounds the WT text. It contains text (usually a single LEFT or RIGHT PARENTHESIS or similar bracketing character). According to JIS X 4051-1995, the parentheses surrounding a warichu may be converted to a SPACE (nominally 1/4 EM in width) at the discretion of the formatter. More... | |
static System::SharedPtr< StructureTypeStandard > | Figure |
(Figure) An item of graphical content. Its placement may be specified with the Placement layout attribute. More... | |
static System::SharedPtr< StructureTypeStandard > | Formula |
static System::SharedPtr< StructureTypeStandard > | Form |
(Form) A widget annotation representing an interactive form field. More... | |
Protected Types | |
using | CreateElementDelegate = System::MulticastDelegate< System::SharedPtr< Element >(System::SharedPtr< Aspose::Pdf::Tagged::TaggedContext >, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive >)> |
Protected Member Functions | |
System::SharedPtr< Element > | CreateElement (System::SharedPtr< Aspose::Pdf::Tagged::TaggedContext > taggedContext, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive > pdfEngineEntity) |
bool | CanBeAppended (System::SharedPtr< StructureTypeStandard > structureType) |
virtual | ~StructureTypeStandard () |
Additional Inherited Members | |
![]() | |
typedef SmartPtr< Object > | ptr |
Alias for smart pointer type. More... | |
typedef System::Details::SharedMembersType | shared_members_type |
structure to keep list of shared pointers contained in object. More... | |
Represents Standard Structure Types.
|
protected |
|
protectedvirtual |
|
protected |
|
protected |
System::SharedPtr<StructureTypeCategory> Aspose::Pdf::LogicalStructure::StructureTypeStandard::get_Category | ( | ) | const |
System::String Aspose::Pdf::LogicalStructure::StructureTypeStandard::get_Tag | ( | ) | const |
Gets tag name of Aspose::Pdf::LogicalStructure::StructureElement.
Tag name of Aspose::Pdf::LogicalStructure::StructureElement.
|
static |
|
virtual |
Returns a string that represents the current object.
|
static |
(Annotation; PDF 1.5) An association between a portion of the ILSE's content and a corresponding PDF annotation. Annot shall be used for all PDF annotations except link annotations and widget annotations.
|
static |
(Article) A relatively self-contained body of text constituting a single narrative or exposition. Articles should be disjoint; that is, they should not contain other articles as constituent elements.
|
static |
(Bibliography entry) A reference identifying the external source of some cited content. It may contain a label (structure type Lbl) as a child.
Although a bibliography entry is likely to include component parts identifying the cited content's author, work, publisher, and so forth, no standard structure types are defined at this level of detail.
|
static |
(Block quotation) A portion of text consisting of one or more paragraphs attributed to someone other than the author of the surrounding text.
|
static |
(Caption) A brief portion of text describing a table or figure.
|
static |
(Code) A fragment of computer program text.
|
static |
(Division) A generic block-level element or group of elements.
|
static |
(Document) A complete document. This is the root element of any structure tree containing multiple parts or multiple articles.
|
static |
(Figure) An item of graphical content. Its placement may be specified with the Placement layout attribute.
|
static |
(Form) A widget annotation representing an interactive form field.
|
static |
(Formula) A mathematical formula.
This structure type is useful only for identifying an entire content element as a formula. No standard structure types are defined for identifying individual components within the formula. From a formatting standpoint, the formula shall be treated similarly to a figure (structure type Figure).
|
static |
(Heading) A label for a subdivision of a document's content. It should be the first child of the division that it heads.
|
static |
Level 1 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting.
|
static |
Level 2 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting.
|
static |
Level 3 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting.
|
static |
Level 4 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting.
|
static |
Level 5 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting.
|
static |
Level 6 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting.
|
static |
(Index) A sequence of entries containing identifying text accompanied by reference elements that point out occurrences of the specified text in the main body of a document.
|
static |
(List) A sequence of items of like meaning and importance. Its immediate children should be an optional caption (structure type Caption) followed by one or more list items (structure type LI).
|
static |
(Label) A name or number that distinguishes a given item from others in the same list or other group of like items.
|
static |
(List body) The descriptive content of a list item. In a dictionary list, for example, it contains the definition of the term. It may either contain the content directly or have other BLSEs, perhaps including nested lists, as children.
|
static |
(List item) An individual member of a list. Its children may be one or more labels, list bodies, or both (structure types Lbl or LBody).
|
static |
(Link) An association between a portion of the ILSE's content and a corresponding link annotation or annotations. Its children should be one or more content items or child ILSEs and one or more object references identifying the associated link annotations.
|
static |
(Nonstructural element) A grouping element having no inherent structural significance; it serves solely for grouping purposes. This type of element differs from a division (structure type Div) in that it shall not be interpreted or exported to other document formats; however, its descendants shall be processed normally.
|
static |
(Note) An item of explanatory text, such as a footnote or an endnote, that is referred to from within the body of the document. It may have a label (structure type Lbl) as a child. The note may be included as a child of the structure element in the body text that refers to it, or it may be included elsewhere (such as in an endnotes section) and accessed by means of a reference (structure type Reference).
Tagged PDF does not prescribe the placement of footnotes in the page content order. They may be either inline or at the end of the page, at the discretion of theconforming writer.
|
static |
(Paragraph) A low-level division of text.
|
static |
(Part) A large-scale division of a document. This type of element is appropriate for grouping articles or sections.
|
static |
(Private element) A grouping element containing private content belonging to the application producing it. The structural significance of this type of element is unspecified and shall be determined entirely by the conforming writer. Neither the Private element nor any of its descendants shall be interpreted or exported to other document formats.
|
static |
(Quotation) An inline portion of text attributed to someone other than the author of the surrounding text.
The quoted text should be contained inline within a single paragraph. This differs from the block-level element BlockQuote, which consists of one or more complete paragraphs (or other elements presented as if they were complete paragraphs).
|
static |
(Ruby base text) The full-size text to which the ruby annotation is applied. RB may contain text, other inline elements, or a mixture of both. It may have the RubyAlignattribute.
|
static |
(Reference) A citation to content elsewhere in the document.
|
static |
(Ruby punctuation) Punctuation surrounding the ruby annotation text. It is used only when a ruby annotation cannot be properly formatted in a ruby style and instead is formatted as a normal comment, or when it is formatted as a warichu. It contains text (usually a single LEFT or RIGHT PARENTHESIS or similar bracketing character).
|
static |
(Ruby annotation text) The smaller-size text that shall be placed adjacent to the ruby base text. It may contain text, other inline elements, or a mixture of both. It may have the RubyAlign and RubyPosition attributes.
|
static |
(Ruby; PDF 1.5) A side-note (annotation) written in a smaller text size and placed adjacent to the base text to which it refers. A Ruby element may also contain the RB, RT, and RP elements.
(Ruby) The wrapper around the entire ruby assembly. It shall contain one RB element followed by either an RT element or a three-element group consisting of RP, RT, and RP. Ruby elements and their content elements shall not break across multiple lines.
|
static |
(Section) A container for grouping related content elements.
|
static |
(Span) A generic inline portion of text having no particular inherent characteristics. It can be used, for example, to delimit a range of text with a given set of styling attributes.
|
static |
(Table) A two-dimensional layout of rectangular data cells, possibly having a complex substructure. It contains either one or more table rows (structure type TR) as children; or an optional table head (structure type THead) followed by one or more table body elements (structure type TBody) and an optional table footer (structure type TFoot). In addition, a table may have a caption (structure type Caption) as its first or last child.
|
static |
(Table body row group; PDF 1.5) A group of rows that constitute the main body portion of a table. If the table is split across multiple pages, the body area may be broken apart on a row boundary. A table may have multiple TBody elements to allow for the drawing of a border or background for a set of rows.
|
static |
(Table data cell) A table cell containing data that is part of the table's content.
|
static |
(Table footer row group; PDF 1.5) A group of rows that constitute the footer of a table. If the table is split across multiple pages, these rows may be redrawn at the bottom of each table fragment (although there is only one TFoot element.)
|
static |
(Table header cell) A table cell containing header text describing one or more rows or columns of the table.
|
static |
(Table header row group; PDF 1.5) A group of rows that constitute the header of a table. If the table is split across multiple pages, these rows may be redrawn at the top of each table fragment (although there is only one THead element).
|
static |
(Table of contents) A list made up of table of contents item entries (structure type TOCI) and/or other nested table of contents entries (TOC).
A TOC entry that includes only TOCI entries represents a flat hierarchy. A TOC entry that includes other nested TOC entries (and possibly TOCI entries) represents a more complex hierarchy.Ideally, the hierarchy of a top level TOC entry reflects the structure of the main body of the document.
|
static |
(Table of contents item) An individual member of a table of contents. This entry’s children may be any of the following structure types:
Lbl | A label |
Reference | A reference to the title and the page number |
NonStruct | Non-structure elements for wrapping a leader artifact |
P | Descriptive text |
TOC | Table of content elements for hierarchical tables of content, as described for the TOC entry |
|
static |
(Table row) A row of headings or data in a table. It may contain table header cells and table data cells (structure types TH and TD).
|
static |
(Warichu; PDF 1.5) A comment or annotation in a smaller text size and formatted onto two smaller lines within the height of the containing text line and placed following (inline) the base text to which it refers. A Warichu element may also contain the WT and WP elements.
(Warichu) The wrapper around the entire warichu assembly. It may contain a three-element group consisting of WP, WT, and WP. Warichu elements (and their content elements) may wrap across multiple lines, according to the warichu breaking rules described in the Japanese Industrial Standard (JIS) X 4051-1995.
|
static |
(Warichu punctuation) The punctuation that surrounds the WT text. It contains text (usually a single LEFT or RIGHT PARENTHESIS or similar bracketing character). According to JIS X 4051-1995, the parentheses surrounding a warichu may be converted to a SPACE (nominally 1/4 EM in width) at the discretion of the formatter.
|
static |
(Warichu text) The smaller-size text of a warichu comment that is formatted into two lines and placed between surrounding WP elements.