PdfWordElement Class


PdfWordElement Class

Represents a Word document that can be added to a pdf page or template.

Inheritance Hierarchy

SystemObject
  SelectPdf.UniversalPdfPageElement
    SelectPdf.UniversalPdfElement
      SelectPdf.UniversalPdfWordElement

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

Syntax

Copy

public sealed class PdfWordElement : PdfElement

Public NotInheritable Class PdfWordElement
	Inherits PdfElement

The PdfWordElement type exposes the following members.

Constructors

	Name	Description
	PdfWordElement(Stream)	Creates a Word element from a stream.
	PdfWordElement(String)	Creates a Word element from a file.
	PdfWordElement(Single, Single, Stream)	Creates a Word element at (x, y) from a stream.
	PdfWordElement(Single, Single, String)	Creates a Word element at (x, y) from a file.
	PdfWordElement(Single, Single, Single, Stream)	Creates a Word element at (x, y) with the specified width from a stream.
	PdfWordElement(Single, Single, Single, String)	Creates a Word element at (x, y) with the specified width from a file.
	PdfWordElement(Single, Single, Single, Single, Stream)	Creates a Word element at (x, y) with the specified size from a stream.
	PdfWordElement(Single, Single, Single, Single, String)	Creates a Word element at (x, y) with the specified size from a file.

Top

Properties

	Name	Description
	ActualText	Gets or sets the exact text represented by this element (the structure element's /ActualText entry), used when the drawn glyphs do not map to readable text. (Inherited from PdfPageElement)
	AlternateText	Gets or sets the alternate text describing this element for assistive technology (the structure element's /Alt entry). Required on figures for PDF/UA conformance. (Inherited from PdfPageElement)
	Artifact	Gets or sets a value indicating whether this element is an artifact — decorative or layout content that carries no meaning and is excluded from the logical structure (backgrounds, rules, running headers). Takes precedence over TagType. (Inherited from PdfPageElement)
	AutoDetectComplexScript	Gets or sets whether complex scripts (Arabic, Hebrew, Indic) are detected and shaped even where the document does not mark them. Default: false.
	BackColor	Gets or sets the background fill color. (Inherited from PdfElement)
	Blending	Gets or sets the blending mode. (Inherited from PdfElement)
	Bookmarks	Gets or sets what the entries added to the host document's outline are made from: the document's headings (the default), its bookmarks, or nothing.
	ColorSpace	Gets or sets the color space for the pdf element rendering. (Inherited from PdfElement)
	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. Default: true.
	ForeColor	Gets or sets the foreground color used for drawing outlines and text. (Inherited from PdfElement)
	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.
	Gradient	Gets or sets the gradient fill. When set, overrides BackColor for fills. (Inherited from PdfElement)
	Height	Gets or sets the destination height in points. A value of -1 (the default) lets the content flow onto the pages that follow. The document is laid out on pages of one height, chosen from the room left below Y so that as little of any page as possible stays blank: the room itself when it is most of a page (the pages after the first then all end that much early), otherwise the largest fraction of a page - a half, a third - that fits the room (the first page then ends early and the pages after it are whole). An element that starts at the top of a page fills every page. A fixed height that fits its page shows what fits in it; a fixed height taller than what is left of the page continues on the pages that follow, the same way, until that much height has been drawn.
	InternalLinksEnabled	Render the document's bookmark links as internal pdf links. Default: true.
	LFN	Path of the diagnostic log file written while rendering. When unset, no log is written.
	LineStyle	Gets or sets the line style for outline drawing. (Inherited from PdfElement)
	OptimizeIdenticalImages	Gets or sets whether identical images are stored once. Default: true.
	PageRanges	Restricts the drawn content to a subset of the rendered pages, e.g. "1", "2-4", "1-3,5,7-". Empty (the default) draws every page.
	Password	Gets or sets the password of an encrypted document. Default: null (the document is not encrypted).
	PdfPagesRectangles	Rectangles in the destination document where each rendered page landed, in client-area coordinates of the page that received it. Index 0 is the page drawn on the host page at (X, Y); subsequent entries are the pages that continued on the pages after it, each at X. Populated after the element has been rendered; null beforehand.
	Rotated	Gets a value indicating whether a rotation has been applied. (Inherited from PdfElement)
	Scaled	Gets a value indicating whether a scale has been applied. (Inherited from PdfElement)
	Skewed	Gets a value indicating whether a skew has been applied. (Inherited from PdfElement)
	Tagged	Produce tagged, accessible (PDF/UA-style) logical structure from this element's rendered content. The structure is taken from the Word engine's own tagged output and re-mapped onto the host document as the element is stamped, exactly like the WordToPdf converter's Options.Tagged.
	TagType	Gets or sets the structure type used to tag this element in a tagged (accessible) document. Ignored unless the document's tagged mode (PdfDocument.Tagged) is enabled. Null (default) leaves the element untagged unless Artifact is set. (Inherited from PdfPageElement)
	Translated	Gets a value indicating whether a translation has been applied. (Inherited from PdfElement)
	Transparency	Gets or sets the transparency level (0 = completely transparent, 100 = completely opaque). (Inherited from PdfElement)
	UpdateFields	Gets or sets whether the document's fields (dates, page references, formulas) are updated before rendering. Default: true.
	Width	Gets or sets the destination width in points. A value of -1 (the default) fits the element to the available client width minus X.
	X	Gets or sets the element X position, in client-area coordinates.
	Y	Gets or sets the element Y position, in client-area coordinates.

Top

Methods

	Name	Description
	Rotate	Applies a rotation transformation. (Inherited from PdfElement)
	Scale	Applies a scale transformation. (Inherited from PdfElement)
	Skew	Applies a skew transformation. (Inherited from PdfElement)
	Translate	Applies a translation transformation. (Inherited from PdfElement)

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 in-process at render time, with every page set to the size of the region it is drawn into and no margins of its own (the region is the paper), and the rendered pages are drawn onto the destination page at (X, Y); when the content overflows the available height, it continues on the pages that follow. Hyperlinks stay clickable and the document's headings (or its bookmarks) become entries in the outline of the host document.

Coordinates and sizes are expressed in the page's client-area coordinate system - relative to the top-left corner of the writable area inside the page margins. Width defaults to the available client width minus X, Height defaults to the available client height minus Y.

Example

Copy

PdfDocument document = new PdfDocument();
PdfPage page = document.AddPage();
PdfWordElement word = new PdfWordElement(0, 0, "letter.docx");
page.Add(word);
document.Save("out.pdf");
document.Close();

Dim document As New PdfDocument()
Dim page As PdfPage = document.AddPage()
Dim word As New PdfWordElement(0, 0, "letter.docx")
page.Add(word)
document.Save("out.pdf")
document.Close()

Reference

SelectPdf.Universal Namespace