CopyOptions

CopyOptions class

Represents the copy options.

class CopyOptions;

Constructors

Name	Description
constructor()	CopyOptions constructor.

Methods

Method	Description
getKeepMacros()	Indicates whether keeping macros;
setKeepMacros(boolean)	Indicates whether keeping macros;
getExtendToAdjacentRange()	Indicates whether extend ranges when copying the range to adjacent range.
setExtendToAdjacentRange(boolean)	Indicates whether extend ranges when copying the range to adjacent range.
getCopyNames()	Indicates whether copying the names.
setCopyNames(boolean)	Indicates whether copying the names.
getCopyInvalidFormulasAsValues()	If the formula is not valid for the dest destination, only copy values.
setCopyInvalidFormulasAsValues(boolean)	If the formula is not valid for the dest destination, only copy values.
getColumnCharacterWidth()	Indicates whether copying column width in unit of characters.
setColumnCharacterWidth(boolean)	Indicates whether copying column width in unit of characters.
getReferToSheetWithSameName()	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)	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()	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)	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.

constructor()

CopyOptions constructor.

constructor();

getKeepMacros()

Indicates whether keeping macros;

getKeepMacros() : boolean;

Remarks

Only for copying workbook.

setKeepMacros(boolean)

Indicates whether keeping macros;

setKeepMacros(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only for copying workbook.

getExtendToAdjacentRange()

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)

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()

Indicates whether copying the names.

getCopyNames() : boolean;

setCopyNames(boolean)

Indicates whether copying the names.

setCopyNames(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getCopyInvalidFormulasAsValues()

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

getCopyInvalidFormulasAsValues() : boolean;

setCopyInvalidFormulasAsValues(boolean)

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()

Indicates whether copying column width in unit of characters.

getColumnCharacterWidth() : boolean;

setColumnCharacterWidth(boolean)

Indicates whether copying column width in unit of characters.

setColumnCharacterWidth(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getReferToSheetWithSameName()

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)

setReferToSheetWithSameName(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is true.

getReferToDestinationSheet()

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)

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.