Excel.RangeView class
Объект rangeView представляет набор видимых ячеек в родительском диапазоне.
- Extends
Комментарии
Используется
Свойства
| cell |
Представляет адреса ячеек в строке |
| column |
Количество видимых столбцов. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| formulas | Представляет формулу в формате A1. Если ячейка не содержит формулы, возвращается ее значение. |
| formulas |
Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если ячейка не содержит формулы, возвращается ее значение. |
| formulasR1C1 | Представляет формулу в формате R1C1. Если ячейка не содержит формулы, возвращается ее значение. |
| index | Возвращает значение, представляющее индекс . |
| number |
Представляет код в числовом формате Excel для данной ячейки. |
| row |
Количество видимых строк. |
| rows | Представляет коллекцию видимых ячеек в диапазоне, сопоставленных с указанным диапазоном. |
| text | Текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Замена знака #, которая происходит в пользовательском интерфейсе Excel, не повлияет на текстовое значение, возвращаемое API-интерфейсом. |
| values | Представляет необработанные значения указанного объекта rangeView. Возвращаемые данные могут иметь строковый, числовой или логический тип. Ячейки, содержащие ошибку, вернут строку ошибки. |
| values |
JSON-представление значений в ячейках в этом диапазоне. В отличие от , |
| values |
JSON-представление значений в ячейках в этом диапазоне. В отличие от , |
| value |
Представляет тип данных каждой ячейки. |
Методы
| get |
Получает родительский диапазон, связанный с текущим |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
cellAddresses
Представляет адреса ячеек в строке RangeView.
readonly cellAddresses: any[][];Значение свойства
any[][]
Комментарии
columnCount
Количество видимых столбцов.
readonly columnCount: number;Значение свойства
number
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
formulas
Представляет формулу в формате A1. Если ячейка не содержит формулы, возвращается ее значение.
formulas: any[][];Значение свойства
any[][]
Комментарии
formulasLocal
Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если ячейка не содержит формулы, возвращается ее значение.
formulasLocal: any[][];Значение свойства
any[][]
Комментарии
formulasR1C1
Представляет формулу в формате R1C1. Если ячейка не содержит формулы, возвращается ее значение.
formulasR1C1: any[][];Значение свойства
any[][]
Комментарии
index
Возвращает значение, представляющее индекс .RangeView
readonly index: number;Значение свойства
number
Комментарии
numberFormat
Представляет код в числовом формате Excel для данной ячейки.
numberFormat: any[][];Значение свойства
any[][]
Комментарии
rowCount
Количество видимых строк.
readonly rowCount: number;Значение свойства
number
Комментарии
rows
Представляет коллекцию видимых ячеек в диапазоне, сопоставленных с указанным диапазоном.
readonly rows: Excel.RangeViewCollection;Значение свойства
Комментарии
text
Текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Замена знака #, которая происходит в пользовательском интерфейсе Excel, не повлияет на текстовое значение, возвращаемое API-интерфейсом.
readonly text: string[][];Значение свойства
string[][]
Комментарии
values
Представляет необработанные значения указанного объекта rangeView. Возвращаемые данные могут иметь строковый, числовой или логический тип. Ячейки, содержащие ошибку, вернут строку ошибки.
values: any[][];Значение свойства
any[][]
Комментарии
valuesAsJson
JSON-представление значений в ячейках в этом диапазоне. В отличие от , RangeView.valuesRangeView.valuesAsJson поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения, заданном пользователем, используйте RangeView.valuesAsJsonLocal.
valuesAsJson: CellValue[][];Значение свойства
Excel.CellValue[][]
Комментарии
valuesAsJsonLocal
JSON-представление значений в ячейках в этом диапазоне. В отличие от , RangeView.valuesRangeView.valuesAsJsonLocal поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту отображения, выбранному пользователем. Для получения данных, не зависящих от языкового стандарта, используйте RangeView.valuesAsJson.
valuesAsJsonLocal: CellValue[][];Значение свойства
Excel.CellValue[][]
Комментарии
valueTypes
Представляет тип данных каждой ячейки.
readonly valueTypes: Excel.RangeValueType[][];Значение свойства
Комментарии
Сведения о методе
getRange()
Получает родительский диапазон, связанный с текущим RangeViewзначением .
getRange(): Excel.Range;Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.RangeViewLoadOptions): Excel.RangeView;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.RangeView;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.RangeView;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.RangeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.RangeViewUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Excel.RangeView): void;Параметры
- properties
- Excel.RangeView
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.RangeView объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.RangeViewData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.RangeViewData;