CopyOptions

CopyOptions class

Represents the copy options.

class CopyOptions;

Constructors

Constructor	Description
constructor()	CopyOptions constructor.

Properties

Property	Type	Description
keepMacros	boolean	Indicates whether keeping macros;
extendToAdjacentRange	boolean	Indicates whether extend ranges when copying the range to adjacent range.
copyNames	boolean	Indicates whether copying the names.
copyInvalidFormulasAsValues	boolean	If the formula is not valid for the dest destination, only copy values.
columnCharacterWidth	boolean	Indicates whether copying column width in unit of characters.
referToSheetWithSameName	boolean	In ms excel, when copying formulas which refer to other worksheets while copying a worksheet to another one, the copied formulas should refer to source workbook. However, for some situations user may need the copied formulas refer to worksheets with the same name in the same workbook, such as when those worksheets have been copied before this copy operation, then this property should be kept as true.
referToDestinationSheet	boolean	When copying the range in the same file and the chart refers to the source sheet, False means the copied chart’s data source will not be changed. True means the copied chart’s data source refers to the destination sheet.

Methods

Method	Description
getKeepMacros()	@deprecated. Please use the ‘keepMacros’ property instead. Indicates whether keeping macros;
setKeepMacros(boolean)	@deprecated. Please use the ‘keepMacros’ property instead. Indicates whether keeping macros;
getExtendToAdjacentRange()	@deprecated. Please use the ’extendToAdjacentRange’ property instead. Indicates whether extend ranges when copying the range to adjacent range.
setExtendToAdjacentRange(boolean)	@deprecated. Please use the ’extendToAdjacentRange’ property instead. Indicates whether extend ranges when copying the range to adjacent range.
getCopyNames()	@deprecated. Please use the ‘copyNames’ property instead. Indicates whether copying the names.
setCopyNames(boolean)	@deprecated. Please use the ‘copyNames’ property instead. Indicates whether copying the names.
getCopyInvalidFormulasAsValues()	@deprecated. Please use the ‘copyInvalidFormulasAsValues’ property instead. If the formula is not valid for the dest destination, only copy values.
setCopyInvalidFormulasAsValues(boolean)	@deprecated. Please use the ‘copyInvalidFormulasAsValues’ property instead. If the formula is not valid for the dest destination, only copy values.
getColumnCharacterWidth()	@deprecated. Please use the ‘columnCharacterWidth’ property instead. Indicates whether copying column width in unit of characters.
setColumnCharacterWidth(boolean)	@deprecated. Please use the ‘columnCharacterWidth’ property instead. Indicates whether copying column width in unit of characters.
getReferToSheetWithSameName()	@deprecated. Please use the ‘referToSheetWithSameName’ property instead. In ms excel, when copying formulas which refer to other worksheets while copying a worksheet to another one, the copied formulas should refer to source workbook. However, for some situations user may need the copied formulas refer to worksheets with the same name in the same workbook, such as when those worksheets have been copied before this copy operation, then this property should be kept as true.
setReferToSheetWithSameName(boolean)	@deprecated. Please use the ‘referToSheetWithSameName’ property instead. In ms excel, when copying formulas which refer to other worksheets while copying a worksheet to another one, the copied formulas should refer to source workbook. However, for some situations user may need the copied formulas refer to worksheets with the same name in the same workbook, such as when those worksheets have been copied before this copy operation, then this property should be kept as true.
getReferToDestinationSheet()	@deprecated. Please use the ‘referToDestinationSheet’ property instead. When copying the range in the same file and the chart refers to the source sheet, False means the copied chart’s data source will not be changed. True means the copied chart’s data source refers to the destination sheet.
setReferToDestinationSheet(boolean)	@deprecated. Please use the ‘referToDestinationSheet’ property instead. When copying the range in the same file and the chart refers to the source sheet, False means the copied chart’s data source will not be changed. True means the copied chart’s data source refers to the destination sheet.
isNull()	Checks whether the implementation object is null.

constructor()

CopyOptions constructor.

constructor();

keepMacros

Indicates whether keeping macros;

keepMacros : boolean;

Remarks

Only for copying workbook.

extendToAdjacentRange

Indicates whether extend ranges when copying the range to adjacent range.

extendToAdjacentRange : boolean;

Remarks

If it’s true, only extends the range of the hyperlink,not adding a new hyperlink when copying hyperlinks to adjacent rows.

copyNames

Indicates whether copying the names.

copyNames : boolean;

copyInvalidFormulasAsValues

If the formula is not valid for the dest destination, only copy values.

copyInvalidFormulasAsValues : boolean;

columnCharacterWidth

Indicates whether copying column width in unit of characters.

columnCharacterWidth : boolean;

referToSheetWithSameName

In ms excel, when copying formulas which refer to other worksheets while copying a worksheet to another one, the copied formulas should refer to source workbook. However, for some situations user may need the copied formulas refer to worksheets with the same name in the same workbook, such as when those worksheets have been copied before this copy operation, then this property should be kept as true.

referToSheetWithSameName : boolean;

Remarks

The default value is true.

referToDestinationSheet

When copying the range in the same file and the chart refers to the source sheet, False means the copied chart’s data source will not be changed. True means the copied chart’s data source refers to the destination sheet.

referToDestinationSheet : boolean;

Remarks

The default value is false, it works as MS Excel.

getKeepMacros()

@deprecated. Please use the ‘keepMacros’ property instead. Indicates whether keeping macros;

getKeepMacros() : boolean;

Remarks

Only for copying workbook.

setKeepMacros(boolean)

@deprecated. Please use the ‘keepMacros’ property instead. Indicates whether keeping macros;

setKeepMacros(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only for copying workbook.

getExtendToAdjacentRange()

@deprecated. Please use the ’extendToAdjacentRange’ property instead. Indicates whether extend ranges when copying the range to adjacent range.

getExtendToAdjacentRange() : boolean;

Remarks

If it’s true, only extends the range of the hyperlink,not adding a new hyperlink when copying hyperlinks to adjacent rows.

setExtendToAdjacentRange(boolean)

@deprecated. Please use the ’extendToAdjacentRange’ property instead. Indicates whether extend ranges when copying the range to adjacent range.

setExtendToAdjacentRange(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

If it’s true, only extends the range of the hyperlink,not adding a new hyperlink when copying hyperlinks to adjacent rows.

getCopyNames()

@deprecated. Please use the ‘copyNames’ property instead. Indicates whether copying the names.

getCopyNames() : boolean;

setCopyNames(boolean)

@deprecated. Please use the ‘copyNames’ property instead. Indicates whether copying the names.

setCopyNames(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getCopyInvalidFormulasAsValues()

@deprecated. Please use the ‘copyInvalidFormulasAsValues’ property instead. If the formula is not valid for the dest destination, only copy values.

getCopyInvalidFormulasAsValues() : boolean;

setCopyInvalidFormulasAsValues(boolean)

@deprecated. Please use the ‘copyInvalidFormulasAsValues’ property instead. If the formula is not valid for the dest destination, only copy values.

setCopyInvalidFormulasAsValues(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getColumnCharacterWidth()

@deprecated. Please use the ‘columnCharacterWidth’ property instead. Indicates whether copying column width in unit of characters.

getColumnCharacterWidth() : boolean;

setColumnCharacterWidth(boolean)

@deprecated. Please use the ‘columnCharacterWidth’ property instead. Indicates whether copying column width in unit of characters.

setColumnCharacterWidth(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getReferToSheetWithSameName()

@deprecated. Please use the ‘referToSheetWithSameName’ property instead. In ms excel, when copying formulas which refer to other worksheets while copying a worksheet to another one, the copied formulas should refer to source workbook. However, for some situations user may need the copied formulas refer to worksheets with the same name in the same workbook, such as when those worksheets have been copied before this copy operation, then this property should be kept as true.

getReferToSheetWithSameName() : boolean;

Remarks

The default value is true.

setReferToSheetWithSameName(boolean)

@deprecated. Please use the ‘referToSheetWithSameName’ property instead. In ms excel, when copying formulas which refer to other worksheets while copying a worksheet to another one, the copied formulas should refer to source workbook. However, for some situations user may need the copied formulas refer to worksheets with the same name in the same workbook, such as when those worksheets have been copied before this copy operation, then this property should be kept as true.

setReferToSheetWithSameName(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is true.

getReferToDestinationSheet()

@deprecated. Please use the ‘referToDestinationSheet’ property instead. When copying the range in the same file and the chart refers to the source sheet, False means the copied chart’s data source will not be changed. True means the copied chart’s data source refers to the destination sheet.

getReferToDestinationSheet() : boolean;

Remarks

The default value is false, it works as MS Excel.

setReferToDestinationSheet(boolean)

@deprecated. Please use the ‘referToDestinationSheet’ property instead. When copying the range in the same file and the chart refers to the source sheet, False means the copied chart’s data source will not be changed. True means the copied chart’s data source refers to the destination sheet.

setReferToDestinationSheet(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is false, it works as MS Excel.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;