Class DocxDocumentInfo

Namespace

PDiffy

Assembly

PDiffy.dll

Document-wide details: the file's properties, language, compatibility and protection settings.

public sealed record DocxDocumentInfo : IEquatable<DocxDocumentInfo>

Inheritance

object

DocxDocumentInfo

Implements

IEquatable<DocxDocumentInfo>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Author

The author in the file's properties (dc:creator), or null when it has none.

public string? Author { get; init; }

Property Value

string

Category

The category in the file's properties, or null when it has none.

public string? Category { get; init; }

Property Value

string

Company

The company in the application properties (docProps/app.xml), or null when it has none.

public string? Company { get; init; }

Property Value

string

CompatibilityMode

Word's compatibility mode, such as 15 for Word 2013 and later.

public int? CompatibilityMode { get; init; }

Property Value

int?

ComplexFont

The default font for complex-script text. A theme font the theme leaves empty is given as its theme name, such as "minorBidi".

public string? ComplexFont { get; init; }

Property Value

string

ComplexLanguage

The default language for complex-script text such as Arabic or Hebrew, for example "ar-SA".

public string? ComplexLanguage { get; init; }

Property Value

string

CustomProperties

The custom properties (docProps/custom.xml), such as a classification label, sorted by name. Each value is given as text, whatever its type.

public IReadOnlyList<DocxProperty> CustomProperties { get; init; }

Property Value

IReadOnlyList<DocxProperty>

DefaultParagraphFormat

How paragraphs are laid out from the document defaults alone, before any style.

public DocxParagraphFormat DefaultParagraphFormat { get; init; }

Property Value

DocxParagraphFormat

DefaultRunFormat

How text looks from the document defaults (w:docDefaults) alone, before any style: the font, size and so on.

public DocxRunFormat DefaultRunFormat { get; init; }

Property Value

DocxRunFormat

DefaultsOther

A hash of the document defaults' formatting that isn't printed, such as character spacing, so changing it changes the snapshot; null when they set none.

public string? DefaultsOther { get; init; }

Property Value

string

Description

The description (comments) in the file's properties, or null when it has none.

public string? Description { get; init; }

Property Value

string

EastAsianFont

The default font for East Asian text. A theme font the theme leaves empty is given as its theme name, such as "minorEastAsia".

public string? EastAsianFont { get; init; }

Property Value

string

EastAsianLanguage

The default language for East Asian text, such as "ja-JP".

public string? EastAsianLanguage { get; init; }

Property Value

string

EvenAndOddHeaders

Whether even and odd pages get different headers and footers.

public bool EvenAndOddHeaders { get; init; }

Property Value

bool

HasCreatedDate

Whether the file's properties record when it was created. The date itself isn't kept.

public bool HasCreatedDate { get; init; }

Property Value

bool

HasModifiedDate

Whether the file's properties record when it was last modified. The date itself isn't kept.

public bool HasModifiedDate { get; init; }

Property Value

bool

Keywords

The keywords in the file's properties as one string, the way the file writes them, or null when it has none.

public string? Keywords { get; init; }

Property Value

string

Language

The default language, such as "en-US", which assistive technology reads with.

public string? Language { get; init; }

Property Value

string

Protection

What editing is restricted to, such as "readOnly" or "forms" (DocxProtections), or null when the document isn't protected.

public string? Protection { get; init; }

Property Value

string

SettingsOther

A hash of the document settings that aren't printed, such as hyphenation or the default tab stop, so changing them changes the snapshot; null when there are none.

public string? SettingsOther { get; init; }

Property Value

string

Subject

The subject in the file's properties, or null when it has none.

public string? Subject { get; init; }

Property Value

string

Template

The template the document is attached to, such as "Normal.dotm", or null when it names none.

public string? Template { get; init; }

Property Value

string

Title

The title in the file's properties (docProps/core.xml), or null when it has none.

public string? Title { get; init; }

Property Value

string

TrackChanges

Whether Track Changes is on, so Word records later edits as tracked changes.

public bool TrackChanges { get; init; }

Property Value

bool

UnreadableParts

Parts of the file that couldn't be read, such as "word/styles.xml" with broken XML.

public IReadOnlyList<DocxUnreadablePart> UnreadableParts { get; init; }

Property Value

IReadOnlyList<DocxUnreadablePart>