PdfWordSection Class


PdfWordSection Class

Represents a Word document that can be added to the header or footer templates of a pdf document.

Inheritance Hierarchy

SystemObject
SelectPdf.UniversalPdfSectionElement
SelectPdf.UniversalPdfWordSection

Namespace: SelectPdf.Universal
Assembly: SelectPdf.Universal (in SelectPdf.Universal.dll) Version: 26.4

Syntax

Copy

public class PdfWordSection : PdfSectionElement

Public Class PdfWordSection
	Inherits PdfSectionElement

The PdfWordSection type exposes the following members.

Constructors

	Name	Description
	PdfWordSection(Stream)	Creates a Word section from a stream that can be added to the header or footer templates of a pdf document.
	PdfWordSection(String)	Creates a Word section from a file that can be added to the header or footer templates of a pdf document.
	PdfWordSection(Single, Single, Stream)	Creates a Word section from a stream that can be added to the header or footer templates of a pdf document.
	PdfWordSection(Single, Single, String)	Creates a Word section from a file that can be added to the header or footer templates of a pdf document.
	PdfWordSection(Single, Single, Single, Stream)	Creates a Word section from a stream that can be added to the header or footer templates of a pdf document.
	PdfWordSection(Single, Single, Single, String)	Creates a Word section from a file that can be added to the header or footer templates of a pdf document.

Top

Properties

	Name	Description
	AutoDetectComplexScript	Gets or sets whether complex scripts (Arabic, Hebrew, Indic) are detected and shaped even where the document does not mark them. Default: false.
	EmbedCompleteFonts	Gets or sets whether the fonts are embedded complete rather than as subsets. Default: false.
	ExternalLinksEnabled	Render the document's web links as clickable links on every page that shows the band. Default: true.
	FilePath	Gets the path of the Word document, or null when the section was created from a stream.
	Format	Gets or sets the format the document is read as. Default: Automatic, which takes the format from the file extension, or detects it from the content (docx family, doc, rtf, WordML) for a stream. Plain text, html and markdown have no signature and must be named here when given as a stream.
	Height	Gets or sets the element height, in points, in the destination pdf page. (Inherited from PdfSectionElement)
	InternalLinksEnabled	Render the document's bookmark links that point inside the shown page as internal pdf links. Default: true.
	LFN	Path of the diagnostic log file written while rendering. When unset, no log is written.
	OptimizeIdenticalImages	Gets or sets whether identical images are stored once. Default: true.
	PageRanges	Selects the page of the rendered document that is shown in the band, e.g. "2". A band shows one page; the first page listed is used. Empty (the default) shows the first page.
	Password	Gets or sets the password of an encrypted document. Default: null (the document is not encrypted).
	UpdateFields	Gets or sets whether the document's fields (dates, page references, formulas) are updated before rendering. Default: true.
	Width	Gets or sets the element width, in points, in the destination pdf page. (Inherited from PdfSectionElement)
	X	Gets or sets the element position on the X axis. (Inherited from PdfSectionElement)
	Y	Gets or sets the element position on the Y axis. (Inherited from PdfSectionElement)

Top

Remarks

The document can be given as a file path or as a stream, in any of the formats of WordFormat. It is rendered once, in-process, with every page set to the size of the destination rectangle and no margins of its own (the header or footer band is the paper), and the resulting first page is drawn onto the header or footer of every page - scaled to the band's width and cut at its height, never stretched. Hyperlinks in the document stay clickable on every page that shows the band.

A section is independent of the converter it is used with: a PdfWordSection can head the pages of a WordToPdf conversion or of an HtmlToPdf one.

Example

Copy

WordToPdf converter = new WordToPdf();
converter.Options.DisplayHeader = true;
converter.Header.Height = 50;
converter.Header.Add(new PdfWordSection("header.docx"));
PdfDocument doc = converter.ConvertFile("report.docx");
doc.Save("out.pdf");
doc.Close();

Dim converter As New WordToPdf()
converter.Options.DisplayHeader = True
converter.Header.Height = 50
converter.Header.Add(New PdfWordSection("header.docx"))
Dim doc As PdfDocument = converter.ConvertFile("report.docx")
doc.Save("out.pdf")
doc.Close()

Reference

SelectPdf.Universal Namespace