Section

Section Public class

Description

A Section is a part of a Document containing other Sections, Paragraphs, List and/or Tables.

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph iTextSharp.text
  iTextSharp.text.Section[[Section]]
  iTextSharp.text.ITextElementArray[[ITextElementArray]]
  class iTextSharp.text.ITextElementArray interfaceStyle;
  iTextSharp.text.IElement[[IElement]]
  class iTextSharp.text.IElement interfaceStyle;
  iTextSharp.text.ILargeElement[[ILargeElement]]
  class iTextSharp.text.ILargeElement interfaceStyle;
  iTextSharp.text.IElement[[IElement]]
  class iTextSharp.text.IElement interfaceStyle;
  end
  subgraph iTextSharp.text.api
  iTextSharp.text.api.IIndentable[[IIndentable]]
  class iTextSharp.text.api.IIndentable interfaceStyle;
  end
  subgraph iTextSharp.text.pdf.interfaces
  iTextSharp.text.pdf.interfaces.IAccessibleElement[[IAccessibleElement]]
  class iTextSharp.text.pdf.interfaces.IAccessibleElement interfaceStyle;
  end
  subgraph System.Collections.Generic
System.Collections.Generic.List_1[[List]]
  end
iTextSharp.text.ITextElementArray --> iTextSharp.text.Section
iTextSharp.text.IElement --> iTextSharp.text.ITextElementArray
iTextSharp.text.ILargeElement --> iTextSharp.text.Section
iTextSharp.text.IElement --> iTextSharp.text.ILargeElement
iTextSharp.text.api.IIndentable --> iTextSharp.text.Section
iTextSharp.text.pdf.interfaces.IAccessibleElement --> iTextSharp.text.Section
System.Collections.Generic.List_1 --> iTextSharp.text.Section

Members

Properties

Public properties

Protected properties

Methods

Public methods

Public Static methods

Details

Summary

A Section is a part of a Document containing other Sections, Paragraphs, List and/or Tables.

Remarks

You can not construct a Section yourself. You will have to ask an instance of Section to the Chapter or Section to which you want to add the new Section.

Example

            Paragraph title2 = new Paragraph("This is Chapter 2", FontFactory.GetFont(FontFactory.HELVETICA, 18, Font.BOLDITALIC, new Color(0, 0, 255)));
            Chapter chapter2 = new Chapter(title2, 2);
            Paragraph someText = new Paragraph("This is some text");
            chapter2.Add(someText);
            Paragraph title21 = new Paragraph("This is Section 1 in Chapter 2", FontFactory.GetFont(FontFactory.HELVETICA, 16, Font.BOLD, new Color(255, 0, 0)));
            Section section1 = chapter2.AddSection(title21);
            Paragraph someSectionText = new Paragraph("This is some silly paragraph in a chapter and/or section. It contains some text to test the functionality of Chapters and Section.");
            section1.Add(someSectionText);
            Paragraph title211 = new Paragraph("This is SubSection 1 in Section 1 in Chapter 2", FontFactory.GetFont(FontFactory.HELVETICA, 14, Font.BOLD, new Color(255, 0, 0)));
            Section section11 = section1.AddSection(40, title211, 2);
            section11.Add(someSectionText);strong>
            

Inheritance

• ITextElementArray
• IElement
• ILargeElement
• IIndentable
• IAccessibleElement
• List<IElement>

Constructors

Section [1/2]

protected internal Section()

Summary

Constructs a new Section.

Section [2/2]

protected internal Section(Paragraph title, int numberDepth)

Arguments

Summary

Constructs a new Section.

Methods

Process

public virtual bool Process(IElementListener listener)

Arguments

Summary

Processes the element by adding it (or the different parts) to an IElementListener.

Returns

true if the element was processed successfully

IsContent

public virtual bool IsContent()

IsNestable

public virtual bool IsNestable()

Add [1/2]

public virtual void Add(int index, IElement element)

Arguments

Summary

Adds a Paragraph, List or Table to this Section.

Add [2/2]

public virtual bool Add(IElement element)

Arguments

Summary

Adds a Paragraph, List, Table or another Section to this Section.

Returns

a bool

AddAll

public virtual bool AddAll<T>(ICollection<T> collection)
where T : IElement

Arguments

AddSection [1/8]

public virtual Section AddSection(float indentation, Paragraph title, int numberDepth)

Arguments

Summary

Creates a Section, adds it to this Section and returns it.

Returns

the newly added Section

AddSection [2/8]

public virtual Section AddSection(float indentation, Paragraph title)

Arguments

Summary

Creates a Section, adds it to this Section and returns it.

Returns

the newly added Section

AddSection [3/8]

public virtual Section AddSection(Paragraph title, int numberDepth)

Arguments

Summary

Creates a Section, add it to this Section and returns it.

Returns

the newly added Section

AddMarkedSection

public virtual MarkedSection AddMarkedSection()

AddSection [4/8]

public virtual Section AddSection(Paragraph title)

Arguments

Summary

Creates a Section, adds it to this Section and returns it.

Returns

the newly added Section

AddSection [5/8]

public virtual Section AddSection(float indentation, string title, int numberDepth)

Arguments

Summary

Adds a Section to this Section and returns it.

Returns

the newly added Section

AddSection [6/8]

public virtual Section AddSection(string title, int numberDepth)

Arguments

Summary

Adds a Section to this Section and returns it.

Returns

the newly added Section

AddSection [7/8]

public virtual Section AddSection(float indentation, string title)

Arguments

Summary

Adds a Section to this Section and returns it.

Returns

the newly added Section

AddSection [8/8]

public virtual Section AddSection(string title)

Arguments

Summary

Adds a Section to this Section and returns it.

Returns

the newly added Section

ConstructTitle

public static Paragraph ConstructTitle(Paragraph title, List<int> numbers, int numberDepth, int numberStyle)

Arguments

IsChapter

public virtual bool IsChapter()

Summary

Checks if this object is a Chapter.

Returns

true if it is a Chapter, false if it is a Section

IsSection

public virtual bool IsSection()

Summary

Checks if this object is a Section.

Returns

true if it is a Section, false if it is a Chapter.

GetBookmarkTitle

public virtual Paragraph GetBookmarkTitle()

ToString

public override string ToString()

SetChapterNumber

public virtual void SetChapterNumber(int number)

Arguments

FlushContent

public virtual void FlushContent()

NewPage

public virtual void NewPage()

GetAccessibleAttribute

public virtual PdfObject GetAccessibleAttribute(PdfName key)

Arguments

SetAccessibleAttribute

public virtual void SetAccessibleAttribute(PdfName key, PdfObject value)

Arguments

GetAccessibleAttributes

public virtual Dictionary<PdfName, PdfObject> GetAccessibleAttributes()

Properties

Type

public virtual int Type { get; }

Summary

Gets the type of the text element.

Value

a type

Chunks

public virtual IList<Chunk> Chunks { get; }

Summary

Gets all the chunks in this element.

Value

an ArrayList

Title

public virtual Paragraph Title { get; set; }

Summary

Get/set the title of this section

Value

a Paragraph

NumberStyle

public virtual int NumberStyle { get; set; }

NumberDepth

public virtual int NumberDepth { get; set; }

Summary

Get/set the numberdepth of this Section.

Value

a int

IndentationLeft

public virtual float IndentationLeft { get; set; }

Summary

Get/set the indentation of this Section on the left side.

Value

the indentation

IndentationRight

public virtual float IndentationRight { get; set; }

Summary

Get/set the indentation of this Section on the right side.

Value

the indentation

Indentation

public virtual float Indentation { get; set; }

Summary

Get/set the indentation of the content of this Section.

Value

the indentation

Depth

public virtual int Depth { get; }

Summary

Returns the depth of this section.

Value

the depth

BookmarkOpen

public virtual bool BookmarkOpen { get; set; }

Summary

Get/set the bookmark

Value

a bool

BookmarkTitle

public virtual string BookmarkTitle { set; }

TriggerNewPage

public virtual bool TriggerNewPage { get; set; }

NotAddedYet

public virtual bool NotAddedYet { get; set; }

AddedCompletely

protected virtual bool AddedCompletely { get; set; }

ElementComplete

public virtual bool ElementComplete { get; set; }

Role

public virtual PdfName Role { get; set; }

ID

public virtual AccessibleElementId ID { get; set; }

IsInline

public virtual bool IsInline { get; }

Generated with ModularDoc