pdfOCR 3.0.2 API
iText.Pdfocr.Structuretree.LogicalStructureTreeItem Class Reference

This class represents structure tree item of the text item put into the pdf document. More...

Inheritance diagram for iText.Pdfocr.Structuretree.LogicalStructureTreeItem:
iText.Pdfocr.Structuretree.ArtifactItem iText.Pdfocr.Structuretree.ParagraphTreeItem iText.Pdfocr.Structuretree.SpanTreeItem iText.Pdfocr.Structuretree.TableCellTreeItem iText.Pdfocr.Structuretree.TableRowTreeItem iText.Pdfocr.Structuretree.TableTreeItem

Public Member Functions

  LogicalStructureTreeItem ()
  Instantiate a new LogicalStructureTreeItem instance. More...
 
  LogicalStructureTreeItem (AccessibilityProperties accessibilityProperties)
  Instantiate a new LogicalStructureTreeItem instance. More...
 
virtual AccessibilityProperties  GetAccessibilityProperties ()
  Retrieve structure tree element's properties. More...
 
virtual iText.Pdfocr.Structuretree.LogicalStructureTreeItem  SetAccessibilityProperties (AccessibilityProperties accessibilityProperties)
  Set structure tree element's properties. More...
 
virtual iText.Pdfocr.Structuretree.LogicalStructureTreeItem  GetParent ()
  Retrieve parent structure tree item. More...
 
virtual iText.Pdfocr.Structuretree.LogicalStructureTreeItem  AddChild (iText.Pdfocr.Structuretree.LogicalStructureTreeItem child)
  Add child structure tree item. More...
 
virtual bool  RemoveChild (iText.Pdfocr.Structuretree.LogicalStructureTreeItem child)
  Remove child structure tree item. More...
 
virtual IList< iText.Pdfocr.Structuretree.LogicalStructureTreeItem GetChildren ()
  Retrieve all child structure tree items. More...
 

Detailed Description

This class represents structure tree item of the text item put into the pdf document.

This class represents structure tree item of the text item put into the pdf document. See iText.Pdfocr.TextInfo.

Constructor & Destructor Documentation

◆ LogicalStructureTreeItem() [1/2]

iText.Pdfocr.Structuretree.LogicalStructureTreeItem.LogicalStructureTreeItem ( )
inline

Instantiate a new LogicalStructureTreeItem instance.

◆ LogicalStructureTreeItem() [2/2]

iText.Pdfocr.Structuretree.LogicalStructureTreeItem.LogicalStructureTreeItem ( AccessibilityProperties  accessibilityProperties )
inline

Instantiate a new LogicalStructureTreeItem instance.

Parameters
accessibilityProperties properties to define and describe pdf structure elements.

Member Function Documentation

◆ AddChild()

virtual iText.Pdfocr.Structuretree.LogicalStructureTreeItem iText.Pdfocr.Structuretree.LogicalStructureTreeItem.AddChild ( iText.Pdfocr.Structuretree.LogicalStructureTreeItem  child )
inlinevirtual

Add child structure tree item.

Parameters
child child structure tree item.
Returns
this LogicalStructureTreeItem instance.

◆ GetAccessibilityProperties()

virtual AccessibilityProperties iText.Pdfocr.Structuretree.LogicalStructureTreeItem.GetAccessibilityProperties ( )
inlinevirtual

Retrieve structure tree element's properties.

Returns
structure tree element's properties.

◆ GetChildren()

virtual IList<iText.Pdfocr.Structuretree.LogicalStructureTreeItem> iText.Pdfocr.Structuretree.LogicalStructureTreeItem.GetChildren ( )
inlinevirtual

Retrieve all child structure tree items.

Returns
all child structure tree items.

◆ GetParent()

virtual iText.Pdfocr.Structuretree.LogicalStructureTreeItem iText.Pdfocr.Structuretree.LogicalStructureTreeItem.GetParent ( )
inlinevirtual

Retrieve parent structure tree item.

Returns
parent structure tree item.

◆ RemoveChild()

virtual bool iText.Pdfocr.Structuretree.LogicalStructureTreeItem.RemoveChild ( iText.Pdfocr.Structuretree.LogicalStructureTreeItem  child )
inlinevirtual

Remove child structure tree item.

Parameters
child child structure tree item.
Returns

true if the child was removed, false otherwise.

◆ SetAccessibilityProperties()

virtual iText.Pdfocr.Structuretree.LogicalStructureTreeItem iText.Pdfocr.Structuretree.LogicalStructureTreeItem.SetAccessibilityProperties ( AccessibilityProperties  accessibilityProperties )
inlinevirtual

Set structure tree element's properties.

Parameters
accessibilityProperties structure tree element's properties.
Returns
this LogicalStructureTreeItem instance.