Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OfficeFormatDescriptor

Namespace OfficeIMO
Assembly OfficeIMO.Core
Implements
IEquatable<OfficeFormatDescriptor>
Modifiers sealed

Describes one concrete Office file format and document kind.

Inheritance

  • Object
  • OfficeFormatDescriptor

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Constructors

public OfficeFormatDescriptor(String id, String extension, OfficeDocumentFamily family, OfficeDocumentKind documentKind, OfficeFormatGeneration generation, OfficeFormatEncoding encoding, Boolean macroEnabled) #

Creates a format descriptor.

Parameters

id System.String requiredposition: 0
extension System.String requiredposition: 1
family OfficeIMO.OfficeDocumentFamily requiredposition: 2
documentKind OfficeIMO.OfficeDocumentKind requiredposition: 3
generation OfficeIMO.OfficeFormatGeneration requiredposition: 4
encoding OfficeIMO.OfficeFormatEncoding requiredposition: 5
macroEnabled System.Boolean requiredposition: 6

Methods

Equals 2 overloads
public virtual Boolean Equals(OfficeFormatDescriptor other) #
Returns: Boolean

Parameters

other OfficeIMO.OfficeFormatDescriptor requiredposition: 0
public override Boolean Equals(Object obj) #
Returns: Boolean

Parameters

obj System.Object requiredposition: 0
public override Int32 GetHashCode() #
Returns: Int32
public override String ToString() #
Returns: String

Properties

public String Id { get; } #

Gets the stable format identifier, such as Word.Docx.

public String Extension { get; } #

Gets the normalized lower-case extension including its leading period.

public OfficeDocumentFamily Family { get; } #

Gets the owning Office document family.

public OfficeDocumentKind DocumentKind { get; } #

Gets the logical document kind.

public OfficeFormatGeneration Generation { get; } #

Gets the format generation.

public OfficeFormatEncoding Encoding { get; } #

Gets the physical encoding.

public Boolean IsMacroEnabled { get; } #

Gets whether the format can carry VBA projects.