OfficeFormatDescriptor
OfficeIMO
Describes one concrete Office file format and document kind.
Inheritance
- object
- OfficeFormatDescriptor
Usage
Explore 5 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 2
Accepted by parameters 3
- Constructor OfficeCompatibilityReport.OfficeCompatibilityReport
- Constructor OfficeCompatibilityReport.OfficeCompatibilityReport
- Method OfficeFormatDescriptor.Equals
Constructors
public OfficeFormatDescriptor(string id, string extension, OfficeDocumentFamily family, OfficeDocumentKind documentKind, OfficeFormatGeneration generation, OfficeFormatEncoding encoding, bool macroEnabled) #Creates a format descriptor.
Parameters
- id string
- extension string
- family OfficeIMO.OfficeDocumentFamily
- documentKind OfficeIMO.OfficeDocumentKind
- generation OfficeIMO.OfficeFormatGeneration
- encoding OfficeIMO.OfficeFormatEncoding
- macroEnabled bool
Methods
public bool Equals(OfficeFormatDescriptor? other) #Indicates whether the current object is equal to another object of the same type.
Parameters
- other OfficeIMO.OfficeFormatDescriptor?
- An object to compare with this object.
Returns
bool true if the current object is equal to the other parameter; otherwise, false.public override bool Equals(object? obj) #Determines whether the specified object is equal to the current object.
Parameters
- obj object?
- The object to compare with the current object.
Returns
bool true if the specified object is equal to the current object; otherwise, false.public override int GetHashCode() #Serves as the default hash function.
Returns
int A hash code for the current object.public override string ToString() #Returns a string that represents the current object.
Returns
string A string that represents the current object.Inherited Methods
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 bool IsMacroEnabled { get; } #Gets whether the format can carry VBA projects.