SummaryInformationBuilder Class

Definition

Namespace

Bodu.IO.Compound.PropertySets

Assembly

Bodu.IO.Compound.dll

Package

Bodu.IO.Compound 1.0.0

Source

SummaryInformationBuilder.cs

Authors a standard summary-information property set, producing an OlePropertySet that can be embedded as the \x05SummaryInformation stream of a compound file.

public sealed class SummaryInformationBuilder

Inheritance

object

SummaryInformationBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

ComparableExtensions.AtMost<T>(T, T, IComparer<T>)

ComparableExtensions.IsEqualTo<T>(T, T, IComparer<T>)

ComparableExtensions.Max<T>(T, T, IComparer<T>)

ComparableExtensions.Min<T>(T, T, IComparer<T>)

Remarks

Each property is optional; only the properties that are set are written. The result reads back through SummaryInformation.

Constructors

SummaryInformationBuilder()

public SummaryInformationBuilder()

Properties

ApplicationName

Gets or sets the name of the application that created the document.

public string? ApplicationName { get; set; }

Property Value

string

The application name, or null when unset.

Author

Gets or sets the document author.

public string? Author { get; set; }

Property Value

string

The author, or null when unset.

CharacterCount

Gets or sets the character count.

public int? CharacterCount { get; set; }

Property Value

int?

The character count, or null when unset.

CodePage

Gets or sets the code page used to encode string properties.

public int CodePage { get; set; }

Property Value

int

The code page; 1252 by default.

Comments

Gets or sets the document comments.

public string? Comments { get; set; }

Property Value

string

The comments, or null when unset.

CreateTime

Gets or sets the time the document was created.

public DateTimeOffset? CreateTime { get; set; }

Property Value

DateTimeOffset?

The creation time, or null when unset.

Keywords

Gets or sets the document keywords.

public string? Keywords { get; set; }

Property Value

string

The keywords, or null when unset.

LastAuthor

Gets or sets the name of the user who last saved the document.

public string? LastAuthor { get; set; }

Property Value

string

The last author, or null when unset.

LastSaveTime

Gets or sets the time the document was last saved.

public DateTimeOffset? LastSaveTime { get; set; }

Property Value

DateTimeOffset?

The last-saved time, or null when unset.

PageCount

Gets or sets the page count.

public int? PageCount { get; set; }

Property Value

int?

The page count, or null when unset.

RevisionNumber

Gets or sets the document revision number.

public string? RevisionNumber { get; set; }

Property Value

string

The revision number, or null when unset.

Subject

Gets or sets the document subject.

public string? Subject { get; set; }

Property Value

string

The subject, or null when unset.

Title

Gets or sets the document title.

public string? Title { get; set; }

Property Value

string

The title, or null when unset.

WordCount

Gets or sets the word count.

public int? WordCount { get; set; }

Property Value

int?

The word count, or null when unset.

Methods

ToArray()

Builds the property set and serializes it to its byte form.

public byte[] ToArray()

Returns

byte[]

The serialized summary-information bytes.

ToPropertySet()

Builds the property set from the assigned properties.

public OlePropertySet ToPropertySet()

Returns

OlePropertySet

An OlePropertySet ready to serialize.

WriteTo(Stream)

Builds the property set and writes its serialized byte form to the supplied stream.

public void WriteTo(Stream stream)

Parameters

stream Stream

The stream to write the summary-information bytes to.

Exceptions

ArgumentNullException

Thrown when stream is null.

Applies to

Product	Versions
.NET	8, 10