2.2.3.50 wjoinbylabel

Contents

Menu Information

Restructure : Join Worksheets by Label

Brief Information

Join multiple worksheets by matching label row

Additional Information

Minimum Origin Version Required: 2015 SR0

Command Line Usage

wjoinbylabel irng:=[Book1](Sheet1,Sheet2) label:=L unmatch:=1 multiple:=1;

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
Input Worksheets irng

Input

Range

<unassigned>

This is used to specify the input worksheet range.

The syntax is: ([BookName]SheetName!, [BookName2]SheetName2!)

Matching Label Row label

Input

string

<unassigned>
 Specify the Label Row by using its Label Row character.

Columns will be joined together according to their Label Row: including Long Name, Units, Comments etc.
Please refer to Column Label Row Characters for the single character of each column label row.

Drop Non-matches unmatch

Input

int

0
 It specifies whether to drop columns (1=drop) with non-matches Label Row when multiple worksheets are joined into a single sheet.
Drop Multiples multiple

Input

int

0
 Whether to keep only one column (1=keep only one) with matched Label Row (drop others) when more than one columns in one or more source worksheets have identical matched Label Row.
Match with All Combinations combine

Input

int

0
 It specifies whether to show (1=show) all combinations for columns with matched Label Rows when source worksheets join into single sheet.
Dataset Identifier id

Input

int

3
 Specify source dataset indentifier.

0 = None, 1 = Range, 2 = Book Name, 3 = Sheet Name, 4 = Use index constructed in index to identify dadtaset source, 5 = Show sheet label of source worksheet.

Index index

Input

string

<auto>
 Available when id = 4. Specify the index of the identifier.

Format is start:increment. For example, >code?1:2</code> will indentify source worksheet as 1,3,5,...

Insert Identifier Before Data idpos

Input

int

0
 Available when id is not 0. Specify whether to put Dataset Identifier before or after data.
Output Worksheet ow

Output

Worksheet

<new>
 Specify the output range, see syntax here.

Description

This X-Function is used to join multiple worksheets into a single worksheet by matching label row, according to the method specified.

You can got the Origin Help page about this tool to learn the details of the functionality of this tool.

Related X-Functions

wAppend, wjoinbycol, wjoincols

Keywords:merge, combine