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

Excel.Interfaces.TableScopedCollectionLoadOptions interface

Пакет:
excel

Представляет коллекцию таблиц с заданной областью. Для каждой таблицы ее верхний левый угол считается ее расположением привязки, и таблицы сортируются сверху вниз, а затем слева направо.

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

$all

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

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

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

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

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

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

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

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

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

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

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

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: имя таблицы.

Заданное имя таблицы должно соответствовать рекомендациям, указанным в статье Переименование таблицы Excel .
rows

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

Для КАЖДОГО ЭЛЕМЕНТА в коллекции. Указывает, отображаются ли в столбцах разноначертное форматирование, в котором нечетные столбцы выделены иначе, чем четные, чтобы упростить чтение таблицы.
showBandedRows

Для каждого элемента в коллекции. Указывает, отображаются ли строки в разном формате, в котором нечетные строки выделены иначе, чем четные, чтобы упростить чтение таблицы.
showFilterButton

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

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

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

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

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

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: значение константы, представляющее стиль таблицы. Возможные значения: "TableStyleLight1" – "TableStyleLight21", "TableStyleMedium1" – "TableStyleMedium28", "TableStyleDark1" – "TableStyleDark11". Также можно указать настраиваемый пользовательский стиль, имеющийся в книге.
tableStyle

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

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

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

$all

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

$all?: boolean;

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

boolean

altTextDescription

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

altTextDescription?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

altTextTitle

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

altTextTitle?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

autoFilter

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

autoFilter?: Excel.Interfaces.AutoFilterLoadOptions;

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

Excel.Interfaces.AutoFilterLoadOptions

Комментарии

[ Набор API: ExcelApi 1.9 ]

columns

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

columns?: Excel.Interfaces.TableColumnCollectionLoadOptions;

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

Excel.Interfaces.TableColumnCollectionLoadOptions

Комментарии

[ Набор API: ExcelApi 1.9 ]

comment

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

comment?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

highlightFirstColumn

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

highlightFirstColumn?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.3 ]

highlightLastColumn

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

highlightLastColumn?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.3 ]

id

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

id?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

isActive

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

isActive?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

legacyId

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

legacyId?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.8 ]

name

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: имя таблицы.

Заданное имя таблицы должно соответствовать рекомендациям, указанным в статье Переименование таблицы Excel .

name?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

rows

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

rows?: Excel.Interfaces.TableRowCollectionLoadOptions;

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

Excel.Interfaces.TableRowCollectionLoadOptions

Комментарии

[ Набор API: ExcelApi 1.9 ]

showBandedColumns

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

showBandedColumns?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.3 ]

showBandedRows

Для каждого элемента в коллекции. Указывает, отображаются ли строки в разном формате, в котором нечетные строки выделены иначе, чем четные, чтобы упростить чтение таблицы.

showBandedRows?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.3 ]

showFilterButton

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

showFilterButton?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.3 ]

showHeaders

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

showHeaders?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

showTotals

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

showTotals?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

sort

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

sort?: Excel.Interfaces.TableSortLoadOptions;

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

Excel.Interfaces.TableSortLoadOptions

Комментарии

[ Набор API: ExcelApi 1.9 ]

source

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

source?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

style

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: значение константы, представляющее стиль таблицы. Возможные значения: "TableStyleLight1" – "TableStyleLight21", "TableStyleMedium1" – "TableStyleMedium28", "TableStyleDark1" – "TableStyleDark11". Также можно указать настраиваемый пользовательский стиль, имеющийся в книге.

style?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

tableStyle

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

tableStyle?: Excel.Interfaces.TableStyleLoadOptions;

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

Excel.Interfaces.TableStyleLoadOptions

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

worksheet

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

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

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

Excel.Interfaces.WorksheetLoadOptions

Комментарии

[ Набор API: ExcelApi 1.9 ]