Class DefinedName
java.lang.Object
com.independentsoft.office.spreadsheet.DefinedName
The Class DefinedName.
-
Constructor Summary
ConstructorsConstructorDescriptionInstantiates a new defined name.DefinedName(String name)Instantiates a new defined name. -
Method Summary
Modifier and TypeMethodDescriptionclone()getBody()Gets the body.Gets the comment.Gets the custom menu text.Gets the description.Gets the function group.getHelp()Gets the help.intGets the local sheet id.getName()Gets the name.Gets the shortcut key.Gets the status bar.booleanChecks if is external function.booleanChecks if is function.booleanisHidden()Checks if is hidden.booleanChecks if is procedure.booleanChecks if is publish to server.booleanChecks if is workbook parameter.voidSets the body.voidsetComment(String comment)Sets the comment.voidsetCustomMenuText(String customMenuText)Sets the custom menu text.voidsetDescription(String description)Sets the description.voidsetExternalFunction(boolean isExternalFunction)Sets the external function.voidsetFunction(boolean isFunction)Sets the function.voidsetFunctionGroup(FunctionGroupCategory functionGroup)Sets the function group.voidSets the help.voidsetHidden(boolean isHidden)Sets the hidden.voidsetLocalSheetID(int localSheetID)Sets the local sheet id.voidSets the name.voidsetProcedure(boolean isProcedure)Sets the procedure.voidsetPublishToServer(boolean publishToServer)Sets the publish to server.voidsetShortcutKey(String shortcutKey)Sets the shortcut key.voidsetStatusBar(String statusBar)Sets the status bar.voidsetWorkbookParameter(boolean isWorkbookParameter)Sets the workbook parameter.toString()
-
Constructor Details
-
DefinedName
public DefinedName()Instantiates a new defined name. -
DefinedName
Instantiates a new defined name.- Parameters:
name- the name
-
-
Method Details
-
clone
-
toString
-
getComment
Gets the comment.- Returns:
- the comment
-
setComment
Sets the comment.- Parameters:
comment- the new comment
-
getCustomMenuText
Gets the custom menu text.- Returns:
- the custom menu text
-
setCustomMenuText
Sets the custom menu text.- Parameters:
customMenuText- the new custom menu text
-
getDescription
Gets the description.- Returns:
- the description
-
setDescription
Sets the description.- Parameters:
description- the new description
-
isFunction
public boolean isFunction()Checks if is function.- Returns:
- true, if is function
-
setFunction
public void setFunction(boolean isFunction)Sets the function.- Parameters:
isFunction- the new function
-
getFunctionGroup
Gets the function group.- Returns:
- the function group
-
setFunctionGroup
Sets the function group.- Parameters:
functionGroup- the new function group
-
getHelp
Gets the help.- Returns:
- the help
-
setHelp
Sets the help.- Parameters:
help- the new help
-
isHidden
public boolean isHidden()Checks if is hidden.- Returns:
- true, if is hidden
-
setHidden
public void setHidden(boolean isHidden)Sets the hidden.- Parameters:
isHidden- the new hidden
-
getLocalSheetID
public int getLocalSheetID()Gets the local sheet id.- Returns:
- the local sheet id
-
setLocalSheetID
public void setLocalSheetID(int localSheetID)Sets the local sheet id.- Parameters:
localSheetID- the new local sheet id
-
getName
Gets the name.- Returns:
- the name
-
setName
Sets the name.- Parameters:
name- the new name
-
isPublishToServer
public boolean isPublishToServer()Checks if is publish to server.- Returns:
- true, if is publish to server
-
setPublishToServer
public void setPublishToServer(boolean publishToServer)Sets the publish to server.- Parameters:
publishToServer- the new publish to server
-
getShortcutKey
Gets the shortcut key.- Returns:
- the shortcut key
-
setShortcutKey
Sets the shortcut key.- Parameters:
shortcutKey- the new shortcut key
-
getStatusBar
Gets the status bar.- Returns:
- the status bar
-
setStatusBar
Sets the status bar.- Parameters:
statusBar- the new status bar
-
isProcedure
public boolean isProcedure()Checks if is procedure.- Returns:
- true, if is procedure
-
setProcedure
public void setProcedure(boolean isProcedure)Sets the procedure.- Parameters:
isProcedure- the new procedure
-
isWorkbookParameter
public boolean isWorkbookParameter()Checks if is workbook parameter.- Returns:
- true, if is workbook parameter
-
setWorkbookParameter
public void setWorkbookParameter(boolean isWorkbookParameter)Sets the workbook parameter.- Parameters:
isWorkbookParameter- the new workbook parameter
-
isExternalFunction
public boolean isExternalFunction()Checks if is external function.- Returns:
- true, if is external function
-
setExternalFunction
public void setExternalFunction(boolean isExternalFunction)Sets the external function.- Parameters:
isExternalFunction- the new external function
-
getBody
Gets the body.- Returns:
- the body
-
setBody
Sets the body.- Parameters:
body- the new body
-