VP SET WORKBOOK OPTIONS

VP SET WORKBOOK OPTIONS ( vpAreaName : Text ; optionObj : Object)

Parameter	Type		Description
vpAreaName	Text	->	4D View Pro area form object name
optionObj	Object	->	Object containing the workbook options to be set

Description

VP SET WORKBOOK OPTIONS sets the workbook options in vpAreaName.

In vpAreaName, pass the name of the 4D View Pro area.

In optionObj, pass the workbook options to apply to vpAreaName.

If optionObj is empty, the command does nothing.

Modified workbook options are saved with the document.

The following table lists the available workbook options:

Property	Type	Description
allowUserDragMerge	boolean	The drag merge operation is allowed (select cells and drag the selection to merge cells)
allowAutoCreateHyperlink	boolean	Enables automatic creation of hyperlinks in the spreadsheet.
allowContextMenu	boolean	The built-in context menu can be opened.
allowCopyPasteExcelStyle	boolean	Styles from a spreadsheet can be copied and pasted to Excel, and vice-versa.
allowDynamicArray	boolean	Enables dynamic arrays in worksheets
allowExtendPasteRange	boolean	Extends the pasted range if the pasted range is not enough for the pasted data
allowSheetReorder	boolean	Sheet reordering is allowed
allowUndo	boolean	Undoing edits is allowed.
allowUserDeselect	boolean	Deselecting specific cells from a selection is allowed.
allowUserDragDrop	boolean	Drag and drop of range data is allowed
allowUserDragFill	boolean	Drag fill is allowed
allowUserEditFormula	boolean	Formulas can be entered in cells
allowUserResize	boolean	Columns and rows can be resized
allowUserZoom	boolean	Zooming (ctrl + mouse wheel) is allowed
autoFitType	number	Content is formatted to fit in cells, or cells and headers. Available values: Constant Value Description vk auto fit type cell 0 The content autofits cells vk auto fit type cell with header 1 The content autofits cells and headers
backColor	string	A color string used to represent the background color of the area, such as "red", "#FFFF00", "rgb(255,0,0)", "Accent 5". The initial backgroundcolor is hidden when a backgroundImage is set.
backgroundImage	string / picture / file	Background image for the area.
backgroundImageLayout	number	How the background image is displayed. Available values: Constant Value Description vk image layout center 1 In the center of the area. vk image layout none 3 In the upper left corner of the area with its original size. vk image layout stretch 0 Fills the area. vk image layout zoom 2 Displayed with its original aspect ratio.
calcOnDemand	boolean	Formulas are calculated only when they are demanded.
columnResizeMode	number	Resize mode for columns. Available values: Constant Value Description vk resize mode normal 0 Use normal resize mode (i.e remaining columns are affected) vk resize mode split 1 Use split mode (i.e remaining columns are not affected)
copyPasteHeaderOptions	number	Headers to include when data is copied to or pasted. Available values: Constant Value Description vk copy paste header options all headers 3 Includes selected headers when data is copied; overwrites selected headers when data is pasted. vk copy paste header options column headers 2 Includes selected column headers when data is copied; overwrites selected column headers when data is pasted. vk copy paste header options no headers 0 Column and row headers are not included when data is copied; does not overwrite selected column or row headers when data is pasted. vk copy paste header options row headers 1 Includes selected row headers when data is copied; overwrites selected row headers when data is pasted.
customList	collection	The list for users to customize drag fill, prioritize matching this list in each fill. Each collection item is a collection of strings. See on SpreadJS docs.
cutCopyIndicatorBorderColor	string	Border color for the indicator displayed when the user cuts or copies the selection.
cutCopyIndicatorVisible	boolean	Display an indicator when copying or cutting the selected item.
defaultDragFillType	number	The default drag fill type. Available values : Constant Value Description vk auto fill type auto 5 Automatically fills cells. vk auto fill type clear values 4 Clears cell values. vk auto fill type copycells 0 Fills cells with all data objects, including values, formatting, and formulas. vk auto fill type fill formatting only 2 Fills cells only with formatting. vk auto fill type fill series 1 Fills cells with series. vk auto fill type fill without formatting 3 Fills cells with values and not formatting.
enableAccessibility	boolean	Accessibility support is enabled in the spreadsheet.
enableFormulaTextbox	boolean	The formula text box is enabled.
grayAreaBackColor	string	A color string used to represent the background color of the gray area , such as "red", "#FFFF00", "rgb(255,0,0)", "Accent 5", and so on.
highlightInvalidData	boolean	Invalid data is highlighted.
iterativeCalculation	boolean	Enables iterative calculation. See on SpreadJS docs.
iterativeCalculationMaximumChange	numeric	Maximum amount of change between two calculation values.
iterativeCalculationMaximumIterations	numeric	Number of times the formula should recalculate.
newTabVisible	boolean	Display a special tab to let users insert new sheets.
numbersFitMode	number	Changes display mode when date/number data width is longer than column width. Available values: Constant Value Description vk numbers fit mode mask 0 Replace data content with "###" and shows tip vk numbers fit mode overflow 1 Display data content as a string. If next cell is empty, overflow the content.
pasteSkipInvisibleRange	boolean	Paste or skip pasting data in invisible ranges: False (default): paste data True: Skip pasting in invisible ranges See SpreadJS docs for more information on invisible ranges.
referenceStyle	number	Style for cell and range references in cell formulas. Available values: Constant Value Description vk reference style A1 0 Use A1 style. vk reference style R1C1 1 Use R1C1 style
resizeZeroIndicator	number	Drawing policy when the row or column is resized to zero. Available values: Constant Value Description vk resize zero indicator default 0 Uses the current drawing policy when the row or column is resized to zero. vk resize zero indicator enhanced 1 Draws two short lines when the row or column is resized to zero.
rowResizeMode	number	The way rows are resized. Available values are the same as columnResizeMode
scrollbarAppearance	number	Scrollbar appearance. Available values: Constant Value Description vk scrollbar appearance mobile 1 Mobile scrollbar appearance. vk scrollbar appearance skin (default) 0 Excel-like classic scrollbar appearance.
scrollbarMaxAlign	boolean	The scroll bar aligns with the last row and column of the active sheet.
scrollbarShowMax	boolean	The displayed scroll bars are based on the entire number of columns and rows in the sheet.
scrollByPixel	boolean	Enable precision scrolling by pixel.
scrollIgnoreHidden	boolean	The scroll bar ignores hidden rows or columns.
scrollPixel	integer	Decides scrolling by that number of pixels at a time when scrollByPixel is true. The final scrolling pixels are the result of scrolling delta * scrollPixel. For example: scrolling delta is 3, scrollPixel is 5, the final scrolling pixels are 15.
showDragDropTip	boolean	Display the drag-drop tip.
showDragFillSmartTag	boolean	Display the drag fill dialog.
showDragFillTip	boolean	Display the drag-fill tip.
showHorizontalScrollbar	boolean	Display the horizontal scroll bar.
showResizeTip	number	How to display the resize tip. Available values: Constant Value Description vk show resize tip both 3 Horizontal and vertical resize tips are displayed. vk show resize tip column 1 Only the horizontal resize tip is displayed. vk show resize tip none 0 No resize tip is displayed. vk show resize tip row 2 Only the vertical resize tip is displayed.
showScrollTip	number	How to display the scroll tip. Available values: Constant Value Description vk show scroll tip both 3 Horizontal and vertical scroll tips are displayed. vk show scroll tip horizontal 1 Only the horizontal scroll tip is displayed. vk show scroll tip none No scroll tip is displayed. vk show scroll tip vertical 2 Only the vertical scroll tip is displayed.
showVerticalScrollbar	boolean	Display the vertical scroll bar.
tabEditable	boolean	The sheet tab strip can be edited.
tabNavigationVisible	boolean	Display the sheet tab navigation.
tabStripPosition	number	Position of the tab strip. Available values: Constant Value Description vk tab strip position bottom 0 Tab strip position is relative to the bottom of the workbook. vk tab strip position left 2 Tab strip position is relative to the left of the workbook. vk tab strip position right 3 Tab strip position is relative to the right of the workbook. vk tab strip position top 1 Tab strip position is relative to the top of the workbook.
tabStripRatio	number	Percentage value (0.x) that specifies how much of the horizontal space will be allocated to the tab strip. The rest of the horizontal area (1 - 0.x) will allocated to the horizontal scrollbar.
tabStripVisible	boolean	Display the sheet tab strip.
tabStripWidth	number	Width of the tab strip when position is left or right. Default and minimum is 80.
useTouchLayout	boolean	Whether to use touch layout to present the Spread component.

Example

To set the allowExtendpasteRange option in "ViewProArea":

var $workbookOptions : Object

$workbookOptions:= New Object
$workbookOptions.allowExtendPasteRange:=True

VP SET WORKBOOK OPTIONS("ViewProArea";$workbookOptions)

See also

VP Get workbook options