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

Excel.RangeView class

  • Ссылка
Пакет:
excel

Объект rangeView представляет набор видимых ячеек в родительском диапазоне.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.3 ]

Свойства

cellAddresses

Представляет адреса RangeViewячеек объекта .
columnCount

Количество видимых столбцов.
context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
formulas

Представляет формулу в формате A1. Если в ячейке нет формулы, возвращается ее значение.
formulasLocal

Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если в ячейке нет формулы, возвращается ее значение.
formulasR1C1

Представляет формулу в формате R1C1. Если в ячейке нет формулы, возвращается ее значение.
index

Возвращает значение, представляющее индекс RangeViewобъекта .
numberFormat

Представляет код в числовом формате Excel для данной ячейки.
rowCount

Количество видимых строк.
rows

Представляет коллекцию видимых ячеек в диапазоне, сопоставленных с указанным диапазоном.
text

Текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Замена знака #, которая происходит в пользовательском интерфейсе Excel, не повлияет на текстовое значение, возвращаемое API-интерфейсом.
values

Представляет необработанные значения указанного объекта rangeView. Могут возвращаться строковые и числовые данные, а также логические значения. Ячейки, содержащие ошибку, вернут строку ошибки.
valuesAsJson

Представление значений в ячейках в этом диапазоне в формате JSON. В отличие от RangeView.valuesподдерживает RangeView.valuesAsJson все типы данных, которые могут находиться в ячейке. Примеры включают форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения пользователя, используйте .RangeView.valuesAsJsonLocal
valuesAsJsonLocal

Представление значений в ячейках в этом диапазоне в формате JSON. В отличие от RangeView.valuesподдерживает RangeView.valuesAsJsonLocal все типы данных, которые могут находиться в ячейке. Примеры включают форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту отображения пользователя. Чтобы получить данные, не зависящие от языкового стандарта, используйте .RangeView.valuesAsJson
valueTypes

Представляет тип данных каждой ячейки.

Методы

getRange()

Возвращает родительский диапазон, связанный с текущим RangeView.
load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.RangeView объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.RangeViewData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

cellAddresses

Представляет адреса RangeViewячеек объекта .

readonly cellAddresses: any[][];

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

any[][]

Комментарии

[ Набор API: ExcelApi 1.3 ]

columnCount

Количество видимых столбцов.

readonly columnCount: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.3 ]

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

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

Excel.RequestContext

formulas

Представляет формулу в формате A1. Если в ячейке нет формулы, возвращается ее значение.

formulas: any[][];

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

any[][]

Комментарии

[ Набор API: ExcelApi 1.3 ]

formulasLocal

Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если в ячейке нет формулы, возвращается ее значение.

formulasLocal: any[][];

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

any[][]

Комментарии

[ Набор API: ExcelApi 1.3 ]

formulasR1C1

Представляет формулу в формате R1C1. Если в ячейке нет формулы, возвращается ее значение.

formulasR1C1: any[][];

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

any[][]

Комментарии

[ Набор API: ExcelApi 1.3 ]

index

Возвращает значение, представляющее индекс RangeViewобъекта .

readonly index: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.3 ]

numberFormat

Представляет код в числовом формате Excel для данной ячейки.

numberFormat: any[][];

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

any[][]

Комментарии

[ Набор API: ExcelApi 1.3 ]

rowCount

Количество видимых строк.

readonly rowCount: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.3 ]

rows

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

readonly rows: Excel.RangeViewCollection;

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

Excel.RangeViewCollection

Комментарии

[ Набор API: ExcelApi 1.3 ]

text

Текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Замена знака #, которая происходит в пользовательском интерфейсе Excel, не повлияет на текстовое значение, возвращаемое API-интерфейсом.

readonly text: string[][];

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

string[][]

Комментарии

[ Набор API: ExcelApi 1.3 ]

values

Представляет необработанные значения указанного объекта rangeView. Могут возвращаться строковые и числовые данные, а также логические значения. Ячейки, содержащие ошибку, вернут строку ошибки.

values: any[][];

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

any[][]

Комментарии

[ Набор API: ExcelApi 1.3 ]

valuesAsJson

Представление значений в ячейках в этом диапазоне в формате JSON. В отличие от RangeView.valuesподдерживает RangeView.valuesAsJson все типы данных, которые могут находиться в ячейке. Примеры включают форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения пользователя, используйте .RangeView.valuesAsJsonLocal

valuesAsJson: CellValue[][];

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

Excel.CellValue[][]

Комментарии

[ Набор API: ExcelApi 1.16 ]

valuesAsJsonLocal

Представление значений в ячейках в этом диапазоне в формате JSON. В отличие от RangeView.valuesподдерживает RangeView.valuesAsJsonLocal все типы данных, которые могут находиться в ячейке. Примеры включают форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту отображения пользователя. Чтобы получить данные, не зависящие от языкового стандарта, используйте .RangeView.valuesAsJson

valuesAsJsonLocal: CellValue[][];

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

Excel.CellValue[][]

Комментарии

[ Набор API: ExcelApi 1.16 ]

valueTypes

Представляет тип данных каждой ячейки.

readonly valueTypes: Excel.RangeValueType[][];

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

Excel.RangeValueType[][]

Комментарии

[ Набор API: ExcelApi 1.3 ]

Сведения о методе

getRange()

Возвращает родительский диапазон, связанный с текущим RangeView.

getRange(): Excel.Range;

Возвращаемое значение

Excel.Range

Комментарии

[ Набор API: ExcelApi 1.3 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.RangeViewLoadOptions): Excel.RangeView;

Параметры

options
Excel.Interfaces.RangeViewLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Excel.RangeView

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.RangeView;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Excel.RangeView

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.RangeView;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Excel.RangeView

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.RangeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties
Excel.Interfaces.RangeViewUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options
OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

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;

Возвращаемое значение

Excel.Interfaces.RangeViewData