LibreOffice: ArrayWrapper Struct Reference

LibreOffice LibreOffice 7.5 SDK API Reference

Loading...
Searching...
No Matches
Public Attributes | List of all members
ArrayWrapper Struct Reference

Allows a UNO sequence that is passed between different language boundaries to indicate it prefers to be represented as a multidimensional array with 0 or 1 based indices. More...

## Public Attributes
boolean | IsZeroIndex
| Indicates whether the Array should be have 1 or 0 based indexing.
any | Array
| Contains the Array to be passed.

## Detailed Description

Allows a UNO sequence that is passed between different language boundaries to indicate it prefers to be represented as a multidimensional array with 0 or 1 based indices.

UNO does not natively represent Multi-Dimensional arrays, instead a sequence can have elements that are themselves sequences (an array of arrays ).

Some languages ( example BASIC ) can natively represent both Multi-Dimensional arrays and array of arrays. Those languages could represent a sequence of sequences as either a Multi-Dimensional array or array of arrays. This structure allows a preference for a Multi-Dimensional array representation to be specified.

## Member Data Documentation

## ◆ Array

any Array

Contains the Array to be passed.

Multi-dimensional arrays can only be represented as a sequence where the elements of the sequence are themselves sequences. N-Levels of indirection are possible, where N is the number of dimensions. Note: its perfectly legal to use this structure with a single dimensioned array just to indicate the array indexing.

## ◆ IsZeroIndex

boolean IsZeroIndex

Indicates whether the Array should be have 1 or 0 based indexing.

The documentation for this struct was generated from the following file:

- com/sun/star/script/ArrayWrapper.idl