Class CTDefinedName

java.lang.Object
org.xlsx4j.sml.CTDefinedName
All Implemented Interfaces:
Child

public class CTDefinedName
extends java.lang.Object
implements Child

Java class for CT_DefinedName complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="CT_DefinedName">
   <simpleContent>
     <extension base="<http://schemas.openxmlformats.org/spreadsheetml/2006/main>ST_Formula">
       <attribute name="name" use="required" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="comment" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="customMenu" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="description" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="help" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="statusBar" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="localSheetId" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
       <attribute name="hidden" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="function" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="vbProcedure" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="xlm" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="functionGroupId" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
       <attribute name="shortcutKey" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="publishToServer" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="workbookParameter" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </extension>
   </simpleContent>
 </complexType>
 
  • Field Summary

    Fields
    Modifier and Type Field Description
    protected java.lang.String comment  
    protected java.lang.String customMenu  
    protected java.lang.String description  
    protected java.lang.Boolean function  
    protected java.lang.Long functionGroupId  
    protected java.lang.String help  
    protected java.lang.Boolean hidden  
    protected java.lang.Long localSheetId  
    protected java.lang.String name  
    protected java.lang.Boolean publishToServer  
    protected java.lang.String shortcutKey  
    protected java.lang.String statusBar  
    protected java.lang.String value  
    protected java.lang.Boolean vbProcedure  
    protected java.lang.Boolean workbookParameter  
    protected java.lang.Boolean xlm  
  • Constructor Summary

    Constructors
    Constructor Description
    CTDefinedName()  
  • Method Summary

    Modifier and Type Method Description
    void afterUnmarshal​(jakarta.xml.bind.Unmarshaller unmarshaller, java.lang.Object parent)
    This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
    java.lang.String getComment()
    Gets the value of the comment property.
    java.lang.String getCustomMenu()
    Gets the value of the customMenu property.
    java.lang.String getDescription()
    Gets the value of the description property.
    java.lang.Long getFunctionGroupId()
    Gets the value of the functionGroupId property.
    java.lang.String getHelp()
    Gets the value of the help property.
    java.lang.Long getLocalSheetId()
    Gets the value of the localSheetId property.
    java.lang.String getName()
    Gets the value of the name property.
    java.lang.Object getParent()
    Gets the parent object in the object tree representing the unmarshalled xml document.
    java.lang.String getShortcutKey()
    Gets the value of the shortcutKey property.
    java.lang.String getStatusBar()
    Gets the value of the statusBar property.
    java.lang.String getValue()
    Gets the value of the value property.
    boolean isFunction()
    Gets the value of the function property.
    boolean isHidden()
    Gets the value of the hidden property.
    boolean isPublishToServer()
    Gets the value of the publishToServer property.
    boolean isVbProcedure()
    Gets the value of the vbProcedure property.
    boolean isWorkbookParameter()
    Gets the value of the workbookParameter property.
    boolean isXlm()
    Gets the value of the xlm property.
    void setComment​(java.lang.String value)
    Sets the value of the comment property.
    void setCustomMenu​(java.lang.String value)
    Sets the value of the customMenu property.
    void setDescription​(java.lang.String value)
    Sets the value of the description property.
    void setFunction​(java.lang.Boolean value)
    Sets the value of the function property.
    void setFunctionGroupId​(java.lang.Long value)
    Sets the value of the functionGroupId property.
    void setHelp​(java.lang.String value)
    Sets the value of the help property.
    void setHidden​(java.lang.Boolean value)
    Sets the value of the hidden property.
    void setLocalSheetId​(java.lang.Long value)
    Sets the value of the localSheetId property.
    void setName​(java.lang.String value)
    Sets the value of the name property.
    void setParent​(java.lang.Object parent)  
    void setPublishToServer​(java.lang.Boolean value)
    Sets the value of the publishToServer property.
    void setShortcutKey​(java.lang.String value)
    Sets the value of the shortcutKey property.
    void setStatusBar​(java.lang.String value)
    Sets the value of the statusBar property.
    void setValue​(java.lang.String value)
    Sets the value of the value property.
    void setVbProcedure​(java.lang.Boolean value)
    Sets the value of the vbProcedure property.
    void setWorkbookParameter​(java.lang.Boolean value)
    Sets the value of the workbookParameter property.
    void setXlm​(java.lang.Boolean value)
    Sets the value of the xlm property.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • value

      protected java.lang.String value
    • name

      protected java.lang.String name
    • comment

      protected java.lang.String comment
    • customMenu

      protected java.lang.String customMenu
    • description

      protected java.lang.String description
    • help

      protected java.lang.String help
    • statusBar

      protected java.lang.String statusBar
    • localSheetId

      protected java.lang.Long localSheetId
    • hidden

      protected java.lang.Boolean hidden
    • function

      protected java.lang.Boolean function
    • vbProcedure

      protected java.lang.Boolean vbProcedure
    • xlm

      protected java.lang.Boolean xlm
    • functionGroupId

      protected java.lang.Long functionGroupId
    • shortcutKey

      protected java.lang.String shortcutKey
    • publishToServer

      protected java.lang.Boolean publishToServer
    • workbookParameter

      protected java.lang.Boolean workbookParameter
  • Constructor Details

    • CTDefinedName

      public CTDefinedName()
  • Method Details

    • getValue

      public java.lang.String getValue()
      Gets the value of the value property.
      Returns:
      possible object is String
    • setValue

      public void setValue​(java.lang.String value)
      Sets the value of the value property.
      Parameters:
      value - allowed object is String
    • getName

      public java.lang.String getName()
      Gets the value of the name property.
      Returns:
      possible object is String
    • setName

      public void setName​(java.lang.String value)
      Sets the value of the name property.
      Parameters:
      value - allowed object is String
    • getComment

      public java.lang.String getComment()
      Gets the value of the comment property.
      Returns:
      possible object is String
    • setComment

      public void setComment​(java.lang.String value)
      Sets the value of the comment property.
      Parameters:
      value - allowed object is String
    • getCustomMenu

      public java.lang.String getCustomMenu()
      Gets the value of the customMenu property.
      Returns:
      possible object is String
    • setCustomMenu

      public void setCustomMenu​(java.lang.String value)
      Sets the value of the customMenu property.
      Parameters:
      value - allowed object is String
    • getDescription

      public java.lang.String getDescription()
      Gets the value of the description property.
      Returns:
      possible object is String
    • setDescription

      public void setDescription​(java.lang.String value)
      Sets the value of the description property.
      Parameters:
      value - allowed object is String
    • getHelp

      public java.lang.String getHelp()
      Gets the value of the help property.
      Returns:
      possible object is String
    • setHelp

      public void setHelp​(java.lang.String value)
      Sets the value of the help property.
      Parameters:
      value - allowed object is String
    • getStatusBar

      public java.lang.String getStatusBar()
      Gets the value of the statusBar property.
      Returns:
      possible object is String
    • setStatusBar

      public void setStatusBar​(java.lang.String value)
      Sets the value of the statusBar property.
      Parameters:
      value - allowed object is String
    • getLocalSheetId

      public java.lang.Long getLocalSheetId()
      Gets the value of the localSheetId property.
      Returns:
      possible object is Long
    • setLocalSheetId

      public void setLocalSheetId​(java.lang.Long value)
      Sets the value of the localSheetId property.
      Parameters:
      value - allowed object is Long
    • isHidden

      public boolean isHidden()
      Gets the value of the hidden property.
      Returns:
      possible object is Boolean
    • setHidden

      public void setHidden​(java.lang.Boolean value)
      Sets the value of the hidden property.
      Parameters:
      value - allowed object is Boolean
    • isFunction

      public boolean isFunction()
      Gets the value of the function property.
      Returns:
      possible object is Boolean
    • setFunction

      public void setFunction​(java.lang.Boolean value)
      Sets the value of the function property.
      Parameters:
      value - allowed object is Boolean
    • isVbProcedure

      public boolean isVbProcedure()
      Gets the value of the vbProcedure property.
      Returns:
      possible object is Boolean
    • setVbProcedure

      public void setVbProcedure​(java.lang.Boolean value)
      Sets the value of the vbProcedure property.
      Parameters:
      value - allowed object is Boolean
    • isXlm

      public boolean isXlm()
      Gets the value of the xlm property.
      Returns:
      possible object is Boolean
    • setXlm

      public void setXlm​(java.lang.Boolean value)
      Sets the value of the xlm property.
      Parameters:
      value - allowed object is Boolean
    • getFunctionGroupId

      public java.lang.Long getFunctionGroupId()
      Gets the value of the functionGroupId property.
      Returns:
      possible object is Long
    • setFunctionGroupId

      public void setFunctionGroupId​(java.lang.Long value)
      Sets the value of the functionGroupId property.
      Parameters:
      value - allowed object is Long
    • getShortcutKey

      public java.lang.String getShortcutKey()
      Gets the value of the shortcutKey property.
      Returns:
      possible object is String
    • setShortcutKey

      public void setShortcutKey​(java.lang.String value)
      Sets the value of the shortcutKey property.
      Parameters:
      value - allowed object is String
    • isPublishToServer

      public boolean isPublishToServer()
      Gets the value of the publishToServer property.
      Returns:
      possible object is Boolean
    • setPublishToServer

      public void setPublishToServer​(java.lang.Boolean value)
      Sets the value of the publishToServer property.
      Parameters:
      value - allowed object is Boolean
    • isWorkbookParameter

      public boolean isWorkbookParameter()
      Gets the value of the workbookParameter property.
      Returns:
      possible object is Boolean
    • setWorkbookParameter

      public void setWorkbookParameter​(java.lang.Boolean value)
      Sets the value of the workbookParameter property.
      Parameters:
      value - allowed object is Boolean
    • getParent

      public java.lang.Object getParent()
      Gets the parent object in the object tree representing the unmarshalled xml document.
      Specified by:
      getParent in interface Child
      Returns:
      The parent object.
    • setParent

      public void setParent​(java.lang.Object parent)
      Specified by:
      setParent in interface Child
    • afterUnmarshal

      public void afterUnmarshal​(jakarta.xml.bind.Unmarshaller unmarshaller, java.lang.Object parent)
      This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
      Parameters:
      parent - The parent object in the object tree.
      unmarshaller - The unmarshaller that generated the instance.