com.groupdocs.editor.formats

Class TextualFormats

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class and Description
      static class  TextualFormats.AllEnumerable
      Implements IEnumerable generic interface, that enables a 'foreach' possibility for the TextualFormats type

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static TextualFormats.AllEnumerable All
      Returns an internal class, that provides enumerable possibilities over all existing Textual formats.
      static TextualFormats Html
      HyperText Markup Language document (HTML) is the extension for web pages created for display in browsers.
      static TextualFormats Md
      Markdown is a lightweight markup language for creating formatted text using a plain-text editor.
      static TextualFormats Txt
      Plain Text Document (TXT) represents a text document that contains plain text in the form of lines.
      static TextualFormats Xml
      eXtensible Markup Language document (XML) that is similar to HTML but different in using tags for defining objects.

    • Constructor Summary

      Constructors 
      Constructor and Description
      TextualFormats() 

    • Field Detail

      • All

        public static final TextualFormats.AllEnumerable All

        Returns an internal class, that provides enumerable possibilities over all existing Textual formats.

      • Html

        public static final TextualFormats Html

        HyperText Markup Language document (HTML) is the extension for web pages created for display in browsers. Learn more about this file format <a href="https://wiki.fileformat.com/web/html">here</a>.

      • Md

        public static final TextualFormats Md

        Markdown is a lightweight markup language for creating formatted text using a plain-text editor. Learn more about this file format <a href="https://docs.fileformat.com/word-processing/md/">here</a>.

      • Txt

        public static final TextualFormats Txt

        Plain Text Document (TXT) represents a text document that contains plain text in the form of lines. Learn more about this file format <a href="https://wiki.fileformat.com/word-processing/txt">here</a>.

      • Xml

        public static final TextualFormats Xml

        eXtensible Markup Language document (XML) that is similar to HTML but different in using tags for defining objects. Learn more about this file format <a href="https://wiki.fileformat.com/web/xml">here</a>.

    • Constructor Detail

      • TextualFormats

        public TextualFormats()

    • Method Detail

      • equals

        public final boolean equals(IDocumentFormat other)

        Determines whether this instance is equal to the other specified IDocumentFormat instance

        Parameters:
        other - Other IDocumentFormat instance. If it is not a TextualFormats, method will return 'false'
        Returns:
        True if are equal, false if are unequal

      • equals

        public boolean equals(Object obj)

        Determines whether this instance is equal to the other specified object, that is presumably of boxed TextualFormats

        Overrides:
        equals in class Object
        Parameters:
        obj - Other boxed TextualFormats instance
        Returns:
        True if are equal, false if are unequal

      • equals

        public final boolean equals(TextualFormats other)

        Determines whether this instance is equal to the other specified TextualFormats instance

        Parameters:
        other - Other TextualFormats instance, that should be checked on equality with this
        Returns:
        True if are equal, false if are unequal

      • fromExtension

        public static TextualFormats fromExtension(String extension)

        Returns instance of TextualFormats structure, associated to specified filename extension, or throws an exception, if extension cannot be properly parsed

        Parameters:
        extension - Filename extension of any supportable textual format, with or without leading dot character, case-independent. Cannot be NULL or empty, should be valid.
        Returns:
        Instance of TextualFormats structure on success or thrown exception on failure

      • getExtension

        public final String getExtension()

        Returns an extension (without leading dot character) of this textual format in lower case

        Specified by:
        getExtension in interface IDocumentFormat
        Returns:

      • getName

        public final String getName()

        Returns a formal full name of this textual format

        Specified by:
        getName in interface IDocumentFormat
        Returns:

      • hashCode

        public int hashCode()

        Returns a hash-code, that is immutable for this instance

        Overrides:
        hashCode in class Object
        Returns:
        Signed 4-byte integer

      • op_Equality

        public static boolean op_Equality(TextualFormats first,
                  TextualFormats second)

        Checks two given TextualFormats instances on equality

        Parameters:
        first - First TextualFormats instance to check
        second - Second TextualFormats instance to check
        Returns:
        True if are equal, false if are unequal

      • op_Inequality

        public static boolean op_Inequality(TextualFormats first,
                    TextualFormats second)

        Checks two given TextualFormats instances on inequality

        Parameters:
        first - First TextualFormats instance to check
        second - Second TextualFormats instance to check
        Returns:
        True if are not equal, false if are equal

      • toString

        public String toString()

        Returns the name of this particular format, same as 'Name' property

        Overrides:
        toString in class Object
        Returns:
        A String that represents this instance