API Reference
OfficeFormatDescriptor
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, Boolean macroEnabled) #Creates a format descriptor.
Parameters
- id System.String
- extension System.String
- family OfficeIMO.OfficeDocumentFamily
- documentKind OfficeIMO.OfficeDocumentKind
- generation OfficeIMO.OfficeFormatGeneration
- encoding OfficeIMO.OfficeFormatEncoding
- macroEnabled System.Boolean
Methods
public Boolean Equals(OfficeFormatDescriptor? other) #BooleanIndicates 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
true if the current object is equal to the other parameter; otherwise, false.
public override Boolean Equals(Object? obj) #BooleanDetermines whether the specified object is equal to the current object.
Parameters
- obj System.Object?
- The object to compare with the current object.
Returns
true if the specified object is equal to the current object; otherwise, false.
public override Int32 GetHashCode() #Int32Serves as the default hash function.
Returns
A hash code for the current object.
public override String ToString() #StringReturns a string that represents the current object.
Returns
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 Boolean IsMacroEnabled { get; } #Gets whether the format can carry VBA projects.