Namespace EasyXLS.FileProperties

Class DocumentSummaryInformation

  • public class DocumentSummaryInformation
extends EasyXLS.FileProperties.Util.PropertySet
    This class stores the properties of the document summary information like company, scale, links dirty, category, hyperlink base, manager and custom properties.

    • Constructor Summary

      Constructors 
      Constructor Description
      DocumentSummaryInformation()
      Defines an instance of the document summary information with the following default properties: company, scale, links dirty.

    • Method Summary

      Modifier and Type Method Description
      System.String getCategory()
      Returns the category property.
      System.String getCompanyName()
      Returns the company name property.
      System.String getCustomProperty​(System.String name)
      Returns a custom property.
      System.String getHyperlinkBase()
      Returns the hyperlink base property.
      bool getLinksDirty()
      Returns the links dirty property.
      System.String getManager()
      Returns the manager property.
      bool getScale()
      Returns the scale property.
      bool HasCustomProperties()
      Returns true if the property set contains custom properties.
      void setCategory​(System.String category)
      Sets the category property.
      void setCompanyName​(System.String companyName)
      Sets the company name property.
      void setCustomProperty​(System.String name, long type, System.String value)
      Adds or sets a custom property.
      void setHyperlinkBase​(System.String hyperlinkBase)
      Sets the hyperlink base property.
      void setLinksDirty​(bool linksDirty)
      Sets the links dirty property.
      void setManager​(System.String manager)
      Sets the manager property.
      void setScale​(bool scale)
      Sets the scale property.

      • Methods inherited from class EasyXLS.FileProperties.Util.PropertySet

        getSection, SectionCount

    • Constructor Detail

      • DocumentSummaryInformation

        public DocumentSummaryInformation()
        Defines an instance of the document summary information with the following default properties: company, scale, links dirty.

    • Method Detail

      • setCategory

        public void setCategory​(System.String category)
        Sets the category property.
        Parameters:
        category - the category property
        See Also:
        getCategory()

      • getCategory

        public System.String getCategory()
        Returns the category property.
        Returns:
        the category property
        See Also:
        setCategory(System.String)

      • setCompanyName

        public void setCompanyName​(System.String companyName)
        Sets the company name property.
        Parameters:
        companyName - the company name property
        See Also:
        getCompanyName()

      • getCompanyName

        public System.String getCompanyName()
        Returns the company name property.
        Returns:
        the company name property
        See Also:
        setCompanyName(System.String)

      • setScale

        public void setScale​(bool scale)
        Sets the scale property.
        Parameters:
        scale - the scale property
        See Also:
        getScale()

      • getScale

        public bool getScale()
        Returns the scale property.
        Returns:
        the scale property
        See Also:
        setScale(bool)

      • setLinksDirty

        public void setLinksDirty​(bool linksDirty)
        Sets the links dirty property.
        Parameters:
        linksDirty - the links dirty property
        See Also:
        getLinksDirty()

      • getLinksDirty

        public bool getLinksDirty()
        Returns the links dirty property.
        Returns:
        the links dirty property
        See Also:
        setLinksDirty(bool)

      • setManager

        public void setManager​(System.String manager)
        Sets the manager property.
        Parameters:
        manager - the manager property
        See Also:
        getManager()

      • getManager

        public System.String getManager()
        Returns the manager property.
        Returns:
        the manager property
        See Also:
        setManager(System.String)

      • setHyperlinkBase

        public void setHyperlinkBase​(System.String hyperlinkBase)
        Sets the hyperlink base property.
        Parameters:
        hyperlinkBase - the hyperlink base property
        See Also:
        getHyperlinkBase()

      • getHyperlinkBase

        public System.String getHyperlinkBase()
        Returns the hyperlink base property.
        Returns:
        the hyperlink base property
        See Also:
        setHyperlinkBase(System.String)

      • setCustomProperty

        public void setCustomProperty​(System.String name,
                              long type,
                              System.String value)
        Adds or sets a custom property.
        Parameters:
        name - the name of the custom property
        type - the type of the custom property. Possible values are available in FileProperty class.
        value - the value of the property. It must be related to the property type.
        See Also:
        getCustomProperty(System.String)

      • getCustomProperty

        public System.String getCustomProperty​(System.String name)
        Returns a custom property.
        Parameters:
        name - the name of the property that will be returned
        Returns:
        the custom property
        See Also:
        setCustomProperty(System.String, long, System.String)