Поделиться через

Excel.Interfaces.RangeCollectionLoadOptions interface

Пакет:
excel

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

$all

Указание $all для параметров загрузки загружает все скалярные свойства (например,Range.address ), но не свойства навигации (например, Range.format.fill.color).
address

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает ссылку на диапазон в стиле A1. Значение address содержит ссылку на лист (например, "Лист1! A1:B4").
addressLocal

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет ссылку на диапазон для указанного диапазона на языке пользователя.
cellCount

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает количество ячеек в диапазоне. Этот API возвращает значение -1, если количество ячеек превышает 2^31-1 (2,147,483,647).
columnCount

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает общее количество столбцов в диапазоне.
columnHidden

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет, скрыты ли все столбцы в текущем диапазоне. Значение — это true , когда все столбцы в диапазоне скрыты. Значение имеет значение, false если столбцы в диапазоне не скрыты. Значением считается, null когда некоторые столбцы в диапазоне скрыты, а другие столбцы в том же диапазоне не скрыты.
columnIndex

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает номер столбца первой ячейки в диапазоне. Используется нулевой индекс.
control

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: доступ к элементу управления ячейки, примененного к этому диапазону. Если диапазон содержит несколько элементов управления ячейками, возвращается EmptyCellControl.
dataValidation

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает объект проверки данных.
format

Для КАЖДОГО ЭЛЕМЕНТА в коллекции возвращает объект формата, инкапсулирующий шрифт, заливку, границы, выравнивание и другие свойства диапазона.
formulaArray

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает формулу массива диапазона. Если указанный диапазон не содержит формулу массива, это свойство возвращает null.
formulas

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет формулу в нотации в стиле A1. Если в ячейке нет формулы, возвращается ее значение.
formulasLocal

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет формулу в нотации в стиле A1 в языковом стандарте пользователя и языковом стандарте форматирования чисел. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если в ячейке нет формулы, возвращается ее значение.
formulasR1C1

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет формулу в нотации в стиле R1C1. Если в ячейке нет формулы, возвращается ее значение.
hasSpill

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет, имеют ли все ячейки границу разлива. Возвращает значение true , если все ячейки имеют границу разлива или false если у всех ячеек нет границы разлива. Возвращает, null если в диапазоне имеются ячейки как с границами разлива, так и без них.
height

Для КАЖДОГО ЭЛЕМЕНТА в коллекции. Возвращает расстояние в точках для 100 % увеличения от верхнего края диапазона до нижнего края диапазона.
hidden

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет, скрыты ли все ячейки в текущем диапазоне. Значение — это true , когда все ячейки в диапазоне скрыты. Значение — это значение false , когда ячейки в диапазоне не скрыты. Значение — это null , когда некоторые ячейки в диапазоне скрыты, а другие ячейки в том же диапазоне не скрыты.
hyperlink

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет гиперссылку для текущего диапазона.
isEntireColumn

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет, является ли текущий диапазон целым столбцом.
isEntireRow

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет, является ли текущий диапазон целой строкой.
left

Для каждого элемента в коллекции. Возвращает расстояние в точках для 100 % увеличения от левого края листа до левого края диапазона.
linkedDataTypeState

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет состояние типа данных каждой ячейки.
numberFormat

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет код числового формата Excel для заданного диапазона. Дополнительные сведения о форматировании чисел в Excel см. в разделе Коды числового формата.
numberFormatCategories

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет категорию числового формата каждой ячейки.
numberFormatLocal

Для КАЖДОГО ЭЛЕМЕНТА в коллекции. Представляет код чисел excel для заданного диапазона на основе языковых параметров пользователя. Excel не выполняет приведение языка или формата при получении или задании numberFormatLocal свойства. Любой возвращаемый текст использует строки в локальном формате на основе языка, указанного в параметрах системы.
rowCount

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает общее количество строк в диапазоне.
rowHidden

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет, скрыты ли все строки в текущем диапазоне. Значение — это true , когда все строки в диапазоне скрыты. Значение — это значение false , когда строки в диапазоне не скрыты. Значением является, null когда некоторые строки в диапазоне скрыты, а другие строки в том же диапазоне не скрыты.
rowIndex

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает номер строки первой ячейки в диапазоне. Используется нулевой индекс.
savedAsArray

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет, будут ли все ячейки сохранены в виде формулы массива. Возвращает значение true , если все ячейки будут сохранены в виде формулы массива или false если все ячейки не будут сохранены в виде формулы массива. Возвращает значение null , если некоторые ячейки будут сохранены в виде формулы массива, а некоторые — нет.
style

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет стиль текущего диапазона. Если стили ячеек несогласованны, null возвращается. Для пользовательских стилей будет возвращено имя стиля. Для встроенных стилей возвращается строка, представляющая значение в перечислении BuiltInStyle .
text

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Подстановка числового знака (#), выполняемая в пользовательском интерфейсе Excel, не повлияет на текстовое значение, возвращаемое API.
top

Для КАЖДОГО ЭЛЕМЕНТА в коллекции. Возвращает расстояние в точках для 100% увеличения от верхнего края листа до верхнего края диапазона.
values

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет необработанные значения указанного диапазона. Возвращаемые данные могут быть строковыми, числовыми или логическими. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращаемое значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу.
valuesAsJson

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представление значений в ячейках в этом диапазоне в формате JSON. В отличие от Range.valuesподдерживает Range.valuesAsJson все типы данных, которые могут находиться в ячейке. Примерами являются форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения пользователя, используйте .Range.valuesAsJsonLocal
valuesAsJsonLocal

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представление значений в ячейках в этом диапазоне в формате JSON. В отличие от Range.valuesподдерживает Range.valuesAsJsonLocal все типы данных, которые могут находиться в ячейке. Примерами являются форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту отображения пользователя. Чтобы получить данные, не зависящие от языкового стандарта, используйте .Range.valuesAsJson
valueTypes

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает тип данных в каждой ячейке.
width

Для КАЖДОГО ЭЛЕМЕНТА в коллекции. Возвращает расстояние в точках для 100% увеличения от левого края диапазона до правого края диапазона.
worksheet

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: лист, содержащий текущий диапазон.

Сведения о свойстве

$all

Указание $all для параметров загрузки загружает все скалярные свойства (например,Range.address ), но не свойства навигации (например, Range.format.fill.color).

$all?: boolean;

Значение свойства

boolean

address

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает ссылку на диапазон в стиле A1. Значение address содержит ссылку на лист (например, "Лист1! A1:B4").

address?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

addressLocal

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет ссылку на диапазон для указанного диапазона на языке пользователя.

addressLocal?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

cellCount

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает количество ячеек в диапазоне. Этот API возвращает значение -1, если количество ячеек превышает 2^31-1 (2,147,483,647).

cellCount?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

columnCount

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает общее количество столбцов в диапазоне.

columnCount?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

columnHidden

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет, скрыты ли все столбцы в текущем диапазоне. Значение — это true , когда все столбцы в диапазоне скрыты. Значение имеет значение, false если столбцы в диапазоне не скрыты. Значением считается, null когда некоторые столбцы в диапазоне скрыты, а другие столбцы в том же диапазоне не скрыты.

columnHidden?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.2 ]

columnIndex

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает номер столбца первой ячейки в диапазоне. Используется нулевой индекс.

columnIndex?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

control

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: доступ к элементу управления ячейки, примененного к этому диапазону. Если диапазон содержит несколько элементов управления ячейками, возвращается EmptyCellControl.

control?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.18 ]

dataValidation

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает объект проверки данных.

dataValidation?: Excel.Interfaces.DataValidationLoadOptions;

Значение свойства

Excel.Interfaces.DataValidationLoadOptions

Комментарии

[ Набор API: ExcelApi 1.9 ]

format

Для КАЖДОГО ЭЛЕМЕНТА в коллекции возвращает объект формата, инкапсулирующий шрифт, заливку, границы, выравнивание и другие свойства диапазона.

format?: Excel.Interfaces.RangeFormatLoadOptions;

Значение свойства

Excel.Interfaces.RangeFormatLoadOptions

Комментарии

[ Набор API: ExcelApi 1.9 ]

formulaArray

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает формулу массива диапазона. Если указанный диапазон не содержит формулу массива, это свойство возвращает null.

formulaArray?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApiDesktop 1.1 ]

formulas

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет формулу в нотации в стиле A1. Если в ячейке нет формулы, возвращается ее значение.

formulas?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

formulasLocal

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет формулу в нотации в стиле A1 в языковом стандарте пользователя и языковом стандарте форматирования чисел. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если в ячейке нет формулы, возвращается ее значение.

formulasLocal?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

formulasR1C1

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет формулу в нотации в стиле R1C1. Если в ячейке нет формулы, возвращается ее значение.

formulasR1C1?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.2 ]

hasSpill

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет, имеют ли все ячейки границу разлива. Возвращает значение true , если все ячейки имеют границу разлива или false если у всех ячеек нет границы разлива. Возвращает, null если в диапазоне имеются ячейки как с границами разлива, так и без них.

hasSpill?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.12 ]

height

Для КАЖДОГО ЭЛЕМЕНТА в коллекции. Возвращает расстояние в точках для 100 % увеличения от верхнего края диапазона до нижнего края диапазона.

height?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.10 ]

hidden

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет, скрыты ли все ячейки в текущем диапазоне. Значение — это true , когда все ячейки в диапазоне скрыты. Значение — это значение false , когда ячейки в диапазоне не скрыты. Значение — это null , когда некоторые ячейки в диапазоне скрыты, а другие ячейки в том же диапазоне не скрыты.

hidden?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.2 ]

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет гиперссылку для текущего диапазона.

hyperlink?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

isEntireColumn

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет, является ли текущий диапазон целым столбцом.

isEntireColumn?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

isEntireRow

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет, является ли текущий диапазон целой строкой.

isEntireRow?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

left

Для каждого элемента в коллекции. Возвращает расстояние в точках для 100 % увеличения от левого края листа до левого края диапазона.

left?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.10 ]

linkedDataTypeState

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет состояние типа данных каждой ячейки.

linkedDataTypeState?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

numberFormat

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет код числового формата Excel для заданного диапазона. Дополнительные сведения о форматировании чисел в Excel см. в разделе Коды числового формата.

numberFormat?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

numberFormatCategories

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет категорию числового формата каждой ячейки.

numberFormatCategories?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.12 ]

numberFormatLocal

Для КАЖДОГО ЭЛЕМЕНТА в коллекции. Представляет код чисел excel для заданного диапазона на основе языковых параметров пользователя. Excel не выполняет приведение языка или формата при получении или задании numberFormatLocal свойства. Любой возвращаемый текст использует строки в локальном формате на основе языка, указанного в параметрах системы.

numberFormatLocal?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

rowCount

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает общее количество строк в диапазоне.

rowCount?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

rowHidden

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет, скрыты ли все строки в текущем диапазоне. Значение — это true , когда все строки в диапазоне скрыты. Значение — это значение false , когда строки в диапазоне не скрыты. Значением является, null когда некоторые строки в диапазоне скрыты, а другие строки в том же диапазоне не скрыты.

rowHidden?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.2 ]

rowIndex

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает номер строки первой ячейки в диапазоне. Используется нулевой индекс.

rowIndex?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

savedAsArray

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет, будут ли все ячейки сохранены в виде формулы массива. Возвращает значение true , если все ячейки будут сохранены в виде формулы массива или false если все ячейки не будут сохранены в виде формулы массива. Возвращает значение null , если некоторые ячейки будут сохранены в виде формулы массива, а некоторые — нет.

savedAsArray?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.12 ]

style

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет стиль текущего диапазона. Если стили ячеек несогласованны, null возвращается. Для пользовательских стилей будет возвращено имя стиля. Для встроенных стилей возвращается строка, представляющая значение в перечислении BuiltInStyle .

style?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

text

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Подстановка числового знака (#), выполняемая в пользовательском интерфейсе Excel, не повлияет на текстовое значение, возвращаемое API.

text?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

top

Для КАЖДОГО ЭЛЕМЕНТА в коллекции. Возвращает расстояние в точках для 100% увеличения от верхнего края листа до верхнего края диапазона.

top?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.10 ]

values

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет необработанные значения указанного диапазона. Возвращаемые данные могут быть строковыми, числовыми или логическими. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращаемое значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу.

values?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

valuesAsJson

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представление значений в ячейках в этом диапазоне в формате JSON. В отличие от Range.valuesподдерживает Range.valuesAsJson все типы данных, которые могут находиться в ячейке. Примерами являются форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения пользователя, используйте .Range.valuesAsJsonLocal

valuesAsJson?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.16 ]

valuesAsJsonLocal

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представление значений в ячейках в этом диапазоне в формате JSON. В отличие от Range.valuesподдерживает Range.valuesAsJsonLocal все типы данных, которые могут находиться в ячейке. Примерами являются форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту отображения пользователя. Чтобы получить данные, не зависящие от языкового стандарта, используйте .Range.valuesAsJson

valuesAsJsonLocal?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.16 ]

valueTypes

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает тип данных в каждой ячейке.

valueTypes?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

width

Для КАЖДОГО ЭЛЕМЕНТА в коллекции. Возвращает расстояние в точках для 100% увеличения от левого края диапазона до правого края диапазона.

width?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.10 ]

worksheet

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: лист, содержащий текущий диапазон.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Значение свойства

Excel.Interfaces.WorksheetLoadOptions

Комментарии

[ Набор API: ExcelApi 1.9 ]