2.2.3.31 wAppend

Contents

Menu Information

Restructure: Append Worksheet

Brief Information

Append multiple worksheets into a single worksheet

Additional Information

Minimum Origin Version Required: 2015 SR0

Command Line Usage

wAppend irng:=([Book1]Sheet1!, [Book1]Sheet2!, [Book2]Sheet1!) method:=row ow:=[<new>]<new>;

wAppend irng:=[Book1] method:=column ow:=[<new>]<new> -r 2;

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
Worksheets wks_list

Input

int

0

This variable is for internal use only and cannot be accessed from script.

Input irng

Input

Range

<unassigned>

This is used to specify the input worksheet range.

The syntax is: ([BookName]SheetName!, [BookName2]SheetName2!). Note that specifying only [BookName] will append all sheets in the book to a single output sheet.

Append by method

Input

int

0

Specify the direction to append worksheets. Option list:

  • column:Column{0}
    The worksheets will be appended as new columns.
  • row:Row{1}
    The worksheets will be appended as new rows.
Append to End of Each Column end

Input

int

0

Available when Append by is Row. Specify whether to append rows to the end of each column without considering max boundary of the worksheet.

Dataset Identifier id

Input

int

3

Specify the source dataset identifier type to show in the output worksheet. Option list:

  • none:None{0}
    Do not show source dataset identifier.
  • range:Range{1}
    Show the Range of source worksheet.
  • book:Book Name{2}
    Show the Name of source workbook.
  • sheet:Sheet Name{3}
    Show the Name of source worksheet.
  • index:Index{4}
    Show the Index of source worksheet, which is specified by Index.
  • sheetLabel:Sheet Label{5}
    Show the sheet label of source worksheet.
Index index

Input

string

<auto>

Available when Dataset Identifier is Index. Specify the Index of source worksheet to show in output..

The syntax is: start:increment, e.g. 0:0.5(0, 0.5, 1, 1.5...), default is <auto>, which equals to 1:1.

Insert Identifier Before Data idpos

Input

int

0

Available when Append by is Row and Dataset Identifier is not None. Specify whether to put Dataset Identifier before or after data.

Output Worksheet ow

Output

Worksheet

<new>

Specify the output range, see syntax here.

Description

You can refer to the Origin Help page to see how to use this tool in a graphical interface.

Related X-Functions

wsplit, wsplit_book, merge_book