WordProcessingFormats
Inheritance: java.lang.Object
All Implemented Interfaces: com.groupdocs.editor.formats.IDocumentFormat
public class WordProcessingFormats implements IDocumentFormat
Encapsulates all WordProcessing formats. Includes the following file types: Doc, Docm, Docx, Dot, Dotm, Dotx, FlatOpc, Odt, Ott, Rtf, WordML. Learn more about Word Processing formats here.
MIME codes are grabbed from the given resources: https://filext.com/faq/office_mime_types.html https://docs.microsoft.com/en-us/previous-versions//cc179224(v=technet.10)
Constructors
| Constructor | Description |
|---|---|
| WordProcessingFormats() |
Fields
| Field | Description |
|---|---|
| Doc | MS Word 97-2007 Binary File Format (DOC) represent documents generated by Microsoft Word or other word processing documents in binary file format. |
| Docx | Office Open XML WordProcessingML Macro-Free Document (DOCX)is a well-known format for Microsoft Word documents. |
| Dot | MS Word 97-2007 Template are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. |
| Docm | Office Open XML WordProcessingML Macro-Enabled Document (DOCM) files are Microsoft Word 2007 or higher generated documents with the ability to run macros. |
| Dotx | Office Open XML WordprocessingML Macro-Free Template (DOTX) are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. |
| Dotm | Office Open XML WordprocessingML Macro-Enabled Template (DOTM) represents template file created with Microsoft Word 2007 or higher. |
| FlatOpc | Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package |
| Rtf | Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications. |
| Odt | Open Document Format Text Document (ODT) files are type of documents created with word processing applications that are based on OpenDocument Text File format. |
| Ott | Open Document Format Text Document Template (OTT) represent template documents generated by applications in compliance with the OASIS’ OpenDocument standard format. |
| WordML | Microsoft Office Word 2003 XML Format \u2014 WordProcessingML or WordML (.XML) |
| All | Returns an internal class, that provides enumerable possibilities over all existing WordProcessing formats |
Methods
| Method | Description |
|---|---|
| getName() | Returns a formal full name of this WordProcessing format |
| getExtension() | Returns an extension (without leading dot character) of this WordProcessing format in lower case |
| getMime() | Returns a MIME code for this format |
| toString() | Returns the name of this particular format, same as ‘Name’ property |
| op_Equality(WordProcessingFormats first, WordProcessingFormats second) | Checks two given WordProcessingFormats instances on equality |
| op_Inequality(WordProcessingFormats first, WordProcessingFormats second) | Checks two given WordProcessingFormats instances on inequality |
| equals(WordProcessingFormats other) | Determines whether this instance is equal to the other specified WordProcessingFormats instance |
| equals(IDocumentFormat other) | Determines whether this instance is equal to the other specified IDocumentFormat instance |
| equals(Object obj) | Determines whether this instance is equal to the other specified object, that is presumably of boxed WordProcessingFormats |
| hashCode() | Returns a hash-code, that is immutable for this instance |
| to_Byte(WordProcessingFormats input) | Returns a byte value from underlying field of specified WordProcessingFormats instance |
| to_WordProcessingFormats(byte raw) | Casts specified raw byte value to valid WordProcessingFormats instance and returns it or throws an exception, is specified value is invalid |
| fromExtension(String extension) | Returns instance of WordProcessingFormats structure, associated to specified filename extension, or throws an exception, if extension cannot be properly parsed |
WordProcessingFormats()
public WordProcessingFormats()
Doc
public static final WordProcessingFormats Doc
MS Word 97-2007 Binary File Format (DOC) represent documents generated by Microsoft Word or other word processing documents in binary file format. Learn more about this file format here.
Docx
public static final WordProcessingFormats Docx
Office Open XML WordProcessingML Macro-Free Document (DOCX)is a well-known format for Microsoft Word documents. Introduced from 2007 with the release of Microsoft Office 2007, the structure of this new Document format was changed from plain binary to a combination of XML and binary files. Learn more about this file format here.
Dot
public static final WordProcessingFormats Dot
MS Word 97-2007 Template are template files created by Microsoft Word to have pre-formatted settings for generation of further DOC or DOCX files. Learn more about this file format here.
Docm
public static final WordProcessingFormats Docm
Office Open XML WordProcessingML Macro-Enabled Document (DOCM) files are Microsoft Word 2007 or higher generated documents with the ability to run macros. Learn more about this file format here.
Dotx
public static final WordProcessingFormats Dotx
Office Open XML WordprocessingML Macro-Free Template (DOTX) are template files created by Microsoft Word to have pre-formatted settings for generation of further DOCX files. Learn more about this file format here.
Dotm
public static final WordProcessingFormats Dotm
Office Open XML WordprocessingML Macro-Enabled Template (DOTM) represents template file created with Microsoft Word 2007 or higher. Learn more about this file format here.
FlatOpc
public static final WordProcessingFormats FlatOpc
Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package
Rtf
public static final WordProcessingFormats Rtf
Rich Text Format (RTF) represents a method of encoding formatted text and graphics for use within applications. Learn more about this file format here.
Odt
public static final WordProcessingFormats Odt
Open Document Format Text Document (ODT) files are type of documents created with word processing applications that are based on OpenDocument Text File format. Learn more about this file format here.
Ott
public static final WordProcessingFormats Ott
Open Document Format Text Document Template (OTT) represent template documents generated by applications in compliance with the OASIS’ OpenDocument standard format. Learn more about this file format here.
WordML
public static final WordProcessingFormats WordML
Microsoft Office Word 2003 XML Format \u2014 WordProcessingML or WordML (.XML)
All
public static final WordProcessingFormats.AllEnumerable All
Returns an internal class, that provides enumerable possibilities over all existing WordProcessing formats
getName()
public final String getName()
Returns a formal full name of this WordProcessing format
Returns: java.lang.String
getExtension()
public final String getExtension()
Returns an extension (without leading dot character) of this WordProcessing format in lower case
Returns: java.lang.String
getMime()
public final String getMime()
Returns a MIME code for this format
Returns: java.lang.String
toString()
public String toString()
Returns the name of this particular format, same as ‘Name’ property
Returns: java.lang.String - A String that represents this instance
op_Equality(WordProcessingFormats first, WordProcessingFormats second)
public static boolean op_Equality(WordProcessingFormats first, WordProcessingFormats second)
Checks two given WordProcessingFormats instances on equality
Parameters:
| Parameter | Type | Description |
|---|---|---|
| first | WordProcessingFormats | First WordProcessingFormats instance to check |
| second | WordProcessingFormats | Second WordProcessingFormats instance to check |
Returns: boolean - True if are equal, false if are unequal
op_Inequality(WordProcessingFormats first, WordProcessingFormats second)
public static boolean op_Inequality(WordProcessingFormats first, WordProcessingFormats second)
Checks two given WordProcessingFormats instances on inequality
Parameters:
| Parameter | Type | Description |
|---|---|---|
| first | WordProcessingFormats | First WordProcessingFormats instance to check |
| second | WordProcessingFormats | Second WordProcessingFormats instance to check |
Returns: boolean - True if are not equal, false if are equal
equals(WordProcessingFormats other)
public final boolean equals(WordProcessingFormats other)
Determines whether this instance is equal to the other specified WordProcessingFormats instance
Parameters:
| Parameter | Type | Description |
|---|---|---|
| other | WordProcessingFormats | Other WordProcessingFormats instance, that should be checked on equality with this |
Returns: boolean - True if are equal, false if are unequal
equals(IDocumentFormat other)
public final boolean equals(IDocumentFormat other)
Determines whether this instance is equal to the other specified IDocumentFormat instance
Parameters:
| Parameter | Type | Description |
|---|---|---|
| other | IDocumentFormat | Other IDocumentFormat instance. If it is not a WordProcessingFormats, method will return ‘false’ |
Returns: boolean - True if are equal, false if are unequal
equals(Object obj)
public boolean equals(Object obj)
Determines whether this instance is equal to the other specified object, that is presumably of boxed WordProcessingFormats
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | java.lang.Object | Other boxed WordProcessingFormats instance |
Returns: boolean - True if are equal, false if are unequal
hashCode()
public int hashCode()
Returns a hash-code, that is immutable for this instance
Returns: int - Signed 4-byte integer
to_Byte(WordProcessingFormats input)
public static byte to_Byte(WordProcessingFormats input)
Returns a byte value from underlying field of specified WordProcessingFormats instance
Parameters:
| Parameter | Type | Description |
|---|---|---|
| input | WordProcessingFormats | Input WordProcessingFormats instance |
Returns: byte
to_WordProcessingFormats(byte raw)
public static WordProcessingFormats to_WordProcessingFormats(byte raw)
Casts specified raw byte value to valid WordProcessingFormats instance and returns it or throws an exception, is specified value is invalid
Parameters:
| Parameter | Type | Description |
|---|---|---|
| raw | byte | Raw byte value |
Returns: WordProcessingFormats
fromExtension(String extension)
public static WordProcessingFormats fromExtension(String extension)
Returns instance of WordProcessingFormats structure, associated to specified filename extension, or throws an exception, if extension cannot be properly parsed
Parameters:
| Parameter | Type | Description |
|---|---|---|
| extension | java.lang.String | Filename extension of any supportable WordProcessing format, with or without leading dot character, case-independent. Cannot be NULL or empty, should be valid. |
Returns: WordProcessingFormats - Instance of WordProcessingFormats structure on success or thrown exception on failure