2.2.3.1 colcopy

Menu Information

Worksheet: Copy Columns to...

Brief Information

Copy data, labels and formatting, masking status from one worksheet column to another

Command Line Usage

1. colcopy irng:=[Book1]Sheet1!Col(1) orng:=[Book1]Sheet1!Col(2);

2. colcopy irng:=[Book1]Sheet1!Col(1) orng:=[Book1]Sheet1!Col(3);

3. colcopy irng:=col(A) orng:=col(B) data:=1 lname:=1 units:=1 comments:=1 para:=1;

4. colcopy irng:=[Book1]Sheet1!1:5 orng:=[Book2]Sheet1!1:5 data:=0 mask:=1; //not copy data, only copy mask status

X-Function Execution Options

Please refer to the page for additional option switches when accessing the x-function from script

Variables

Display
Name
Variable
Name
I/O
and
Type
Default
Value
Description
Source Column(s) irng

Input

Range

<active>
Specify Source column to copy
Destination Column(s) orng

Output

Range

<new>!<new>
Specify Destination column for copied data
Copy Data data

Input

int

1
Specify whether or not to copy data
Copy Sampling Intervals interval

Input

int

0
Specify whether or not to copy Sampling Intervals
Ignore Hidden Rows hidden

Input

int

1
Ignore hidden rows when copying column(s). Set to 0 to copy all rows.
Copy Mask mask

Input

int

0
Specify whether to copy the masking status of the column data.
Copy Column Format format

Input

int

1
Specify whether or not to copy column data format(s)
Copy Cell Format cell

Input

int

0
Specify whether or not to copy cell data format(s)
Long Name lname

Input

int

1
Specify whether or not to copy Long Name
Units units

Input

int

1
Specify whether or not to copy Units
Comments comments

Input

int

1
Specify whether or not to copy Comments
Parameters para

Input

int

1
Specify whether or not to copy Parameters
User-Defined Parameters usrdef

Input

int

1
Specify whether or not to copy user-defined parameters
Sort Result by Reference Column sort

Input

int

0
Sort Result by Reference Column
  • 0=unsorted:Unsorted
  • 1=asc:Ascending
  • 2=desc:Descending
Reference Column ref

Input

Range

<optional>
Reference column

Description

This function is used to copy columns and, optionally, related format & headers, to other columns.

Like other X-Functions, if the Recalculate Mode for the Copy Columns to operation is set to Auto or Manual, a green lock icon will be set in the destination column(s). Left-clicking on the lock opens a menu. If the destination column(s) are not in the same worksheet as the source columns, there will be three worksheet filter related options in this menu.

Initially, only the Worksheet Filters: Lock menu item will be available. In this state, a change to the filter condition of the source worksheet will trigger an update to the data in the destination column(s). If you click Worksheet Filters: Lock once, the destination worksheet columns become locked, and changes to the filter condition of the source worksheet will no longer trigger an update to the destination column(s).

Worksheet Filters:Lock

When this option is selected, the result will be locked from data filter condition change of source column(s). So when the filter condition in the source column worksheet is changed, it will not trigger update in the destination column(s).

Worksheet Filters:Reload

This option is only available when the Worksheet Filter: Lock has been selected already. It reloads the data filter condition from the source column(s) to the destination column(s). i.e. after you changed the data filter condition of the source column(s), click this option to trigger the auto update of the locked destination column(s), so that the same filter condition applies to destination column(s) as well.

Worksheet Filters:Push Back

This option is only available when the Worksheet Filter: Lock has been selected already. It pushes the initial data filter condition back to the source column(s). i.e. after you changed the data filter condition of the source worksheet, click this option and the most recent data filter condition that has been applied from source column(s) to destination column(s) will be pushed back to the source worksheet. Note that if you applied a data filter directly to destination column(s), it will not be pushed back to source.

Related X-Functions

colmove, colswap