CTDefinedName (docx4j-openxml-objects-sml 8.3.4 API)

java.lang.Object
- org.xlsx4j.sml.CTDefinedName

All Implemented Interfaces:: Child

public class CTDefinedName
extends 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 and Description
`protected String`	`comment`
`protected String`	`customMenu`
`protected String`	`description`
`protected Boolean`	`function`
`protected Long`	`functionGroupId`
`protected String`	`help`
`protected Boolean`	`hidden`
`protected Long`	`localSheetId`
`protected String`	`name`
`protected Boolean`	`publishToServer`
`protected String`	`shortcutKey`
`protected String`	`statusBar`
`protected String`	`value`
`protected Boolean`	`vbProcedure`
`protected Boolean`	`workbookParameter`
`protected Boolean`	`xlm`

Constructor Summary

Constructors
Constructor and Description

CTDefinedName()

Constructors
Constructor and Description
`CTDefinedName()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterUnmarshal(Unmarshaller unmarshaller, Object parent)` This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
`String`	`getComment()` Gets the value of the comment property.
`String`	`getCustomMenu()` Gets the value of the customMenu property.
`String`	`getDescription()` Gets the value of the description property.
`Long`	`getFunctionGroupId()` Gets the value of the functionGroupId property.
`String`	`getHelp()` Gets the value of the help property.
`Long`	`getLocalSheetId()` Gets the value of the localSheetId property.
`String`	`getName()` Gets the value of the name property.
`Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`String`	`getShortcutKey()` Gets the value of the shortcutKey property.
`String`	`getStatusBar()` Gets the value of the statusBar property.
`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(String value)` Sets the value of the comment property.
`void`	`setCustomMenu(String value)` Sets the value of the customMenu property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setFunction(Boolean value)` Sets the value of the function property.
`void`	`setFunctionGroupId(Long value)` Sets the value of the functionGroupId property.
`void`	`setHelp(String value)` Sets the value of the help property.
`void`	`setHidden(Boolean value)` Sets the value of the hidden property.
`void`	`setLocalSheetId(Long value)` Sets the value of the localSheetId property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setParent(Object parent)`
`void`	`setPublishToServer(Boolean value)` Sets the value of the publishToServer property.
`void`	`setShortcutKey(String value)` Sets the value of the shortcutKey property.
`void`	`setStatusBar(String value)` Sets the value of the statusBar property.
`void`	`setValue(String value)` Sets the value of the value property.
`void`	`setVbProcedure(Boolean value)` Sets the value of the vbProcedure property.
`void`	`setWorkbookParameter(Boolean value)` Sets the value of the workbookParameter property.
`void`	`setXlm(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 Detail
  - value
```
protected String value
```
  - name
```
protected String name
```
  - comment
```
protected String comment
```
  - customMenu
```
protected String customMenu
```
  - description
```
protected String description
```
  - help
```
protected String help
```
  - statusBar
```
protected String statusBar
```
  - localSheetId
```
protected Long localSheetId
```
  - hidden
```
protected Boolean hidden
```
  - function
```
protected Boolean function
```
  - vbProcedure
```
protected Boolean vbProcedure
```
  - xlm
```
protected Boolean xlm
```
  - functionGroupId
```
protected Long functionGroupId
```
  - shortcutKey
```
protected String shortcutKey
```
  - publishToServer
```
protected Boolean publishToServer
```
  - workbookParameter
```
protected Boolean workbookParameter
```
- Constructor Detail
  - CTDefinedName
```
public CTDefinedName()
```
- Method Detail
  - getValue
```
public String getValue()
```
    Gets the value of the value property.
    
    Returns:
    
    possible object is String
  - setValue
```
public void setValue(String value)
```
    Sets the value of the value property.
    
    Parameters:
    
    value - allowed object is String
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getComment
```
public String getComment()
```
    Gets the value of the comment property.
    
    Returns:
    
    possible object is String
  - setComment
```
public void setComment(String value)
```
    Sets the value of the comment property.
    
    Parameters:
    
    value - allowed object is String
  - getCustomMenu
```
public String getCustomMenu()
```
    Gets the value of the customMenu property.
    
    Returns:
    
    possible object is String
  - setCustomMenu
```
public void setCustomMenu(String value)
```
    Sets the value of the customMenu property.
    
    Parameters:
    
    value - allowed object is String
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - getHelp
```
public String getHelp()
```
    Gets the value of the help property.
    
    Returns:
    
    possible object is String
  - setHelp
```
public void setHelp(String value)
```
    Sets the value of the help property.
    
    Parameters:
    
    value - allowed object is String
  - getStatusBar
```
public String getStatusBar()
```
    Gets the value of the statusBar property.
    
    Returns:
    
    possible object is String
  - setStatusBar
```
public void setStatusBar(String value)
```
    Sets the value of the statusBar property.
    
    Parameters:
    
    value - allowed object is String
  - getLocalSheetId
```
public Long getLocalSheetId()
```
    Gets the value of the localSheetId property.
    
    Returns:
    
    possible object is Long
  - setLocalSheetId
```
public void setLocalSheetId(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(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(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(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(Boolean value)
```
    Sets the value of the xlm property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getFunctionGroupId
```
public Long getFunctionGroupId()
```
    Gets the value of the functionGroupId property.
    
    Returns:
    
    possible object is Long
  - setFunctionGroupId
```
public void setFunctionGroupId(Long value)
```
    Sets the value of the functionGroupId property.
    
    Parameters:
    
    value - allowed object is Long
  - getShortcutKey
```
public String getShortcutKey()
```
    Gets the value of the shortcutKey property.
    
    Returns:
    
    possible object is String
  - setShortcutKey
```
public void setShortcutKey(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(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(Boolean value)
```
    Sets the value of the workbookParameter property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getParent
```
public 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(Object parent)
```
    Specified by:
    
    setParent in interface Child
  - afterUnmarshal
```
public void afterUnmarshal(Unmarshaller unmarshaller,
                           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.

Class CTDefinedName

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

value

name

comment

customMenu

description

help

statusBar

localSheetId

hidden

function

vbProcedure

xlm

functionGroupId

shortcutKey

publishToServer

workbookParameter

Constructor Detail

CTDefinedName

Method Detail

getValue

setValue

getName

setName

getComment

setComment

getCustomMenu

setCustomMenu

getDescription

setDescription

getHelp

setHelp

getStatusBar

setStatusBar

getLocalSheetId

setLocalSheetId

isHidden

setHidden

isFunction

setFunction

isVbProcedure

setVbProcedure

isXlm

setXlm

getFunctionGroupId

setFunctionGroupId

getShortcutKey

setShortcutKey

isPublishToServer

setPublishToServer

isWorkbookParameter

setWorkbookParameter

getParent

setParent

afterUnmarshal