Excel.AllowEditRange class

Пакет:

excel

Представляет объект, AllowEditRange найденный на листе. Этот объект работает со свойствами защиты листа. Если включена защита листа, AllowEditRange объект можно использовать для разрешения редактирования определенного диапазона, сохраняя при этом защиту остальной части листа.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

Свойства

address	Указывает диапазон, связанный с объектом . Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена и не приостановлена, этот метод выдает ошибку AccessDenied и не задает диапазон.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
isPasswordProtected	Указывает, защищен ли объект паролем.
title	Задает заголовок объекта. Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена и не приостановлена, этот метод выдает ошибку AccessDenied и не удается задать заголовок. Если уже существует AllowEditRange объект с той же строкой или строка пуста null (""), этот метод выдает ошибку InvalidArgument и не удается задать заголовок.

Методы

delete()	Удаляет объект из AllowEditRangeCollection. Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена и не приостановлена, этот метод выдает ошибку AccessDenied и завершается сбоем операции удаления.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
pauseProtection(password)	Приостанавливает защиту листа для объекта для пользователя в текущем сеансе. Этот метод ничего не делает, если защита листа не включена или уже приостановлена. Если не удается приостановить защиту листа, этот метод выдает ошибку UnsupportedOperation и не приостанавливает защиту объекта. Если пароль неправильный, этот метод выдает ошибку BadPassword и не приостанавливает защиту для объекта. Если пароль указан, но объекту не требуется пароль, введенный пароль будет игнорироваться, и операция будет выполнена успешно.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setPassword(password)	Изменяет пароль, связанный с объектом . Установка строки пароля как пустой ("") или null приведет к удалению защиты паролем для объекта. Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена и не приостановлена, этот метод выдает ошибку AccessDenied и операция установки завершается сбоем.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.AllowEditRange является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.AllowEditRangeData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

address

Указывает диапазон, связанный с объектом . Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена и не приостановлена, этот метод выдает ошибку AccessDenied и не задает диапазон.

address: string;

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

string

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

context

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

context: RequestContext;

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

Excel.RequestContext

isPasswordProtected

Указывает, защищен ли объект паролем.

readonly isPasswordProtected: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

title

Задает заголовок объекта. Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена и не приостановлена, этот метод выдает ошибку AccessDenied и не удается задать заголовок. Если уже существует AllowEditRange объект с той же строкой или строка пуста null (""), этот метод выдает ошибку InvalidArgument и не удается задать заголовок.

title: string;

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

string

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

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

delete()

Удаляет объект из AllowEditRangeCollection. Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена и не приостановлена, этот метод выдает ошибку AccessDenied и завершается сбоем операции удаления.

delete(): void;

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

void

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

load(options)

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

load(options?: Excel.Interfaces.AllowEditRangeLoadOptions): Excel.AllowEditRange;

Параметры

options

Excel.Interfaces.AllowEditRangeLoadOptions

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

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

Excel.AllowEditRange

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.AllowEditRange

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.AllowEditRange

pauseProtection(password)

Приостанавливает защиту листа для объекта для пользователя в текущем сеансе. Этот метод ничего не делает, если защита листа не включена или уже приостановлена. Если не удается приостановить защиту листа, этот метод выдает ошибку UnsupportedOperation и не приостанавливает защиту объекта. Если пароль неправильный, этот метод выдает ошибку BadPassword и не приостанавливает защиту для объекта. Если пароль указан, но объекту не требуется пароль, введенный пароль будет игнорироваться, и операция будет выполнена успешно.

pauseProtection(password?: string): void;

Параметры

password

string

Пароль, связанный AllowEditRange с объектом .

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

void

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

set(properties, options)

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

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

Параметры

properties

Excel.Interfaces.AllowEditRangeUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.AllowEditRange): void;

Параметры

properties

Excel.AllowEditRange

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

void

setPassword(password)

Изменяет пароль, связанный с объектом . Установка строки пароля как пустой ("") или null приведет к удалению защиты паролем для объекта. Чтобы этот метод работал правильно, защита листа должна быть отключена или приостановлена. Если защита листа включена и не приостановлена, этот метод выдает ошибку AccessDenied и операция установки завершается сбоем.

setPassword(password?: string): void;

Параметры

password

string

Пароль, связанный AllowEditRange с объектом .

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

void

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

toJSON()

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

toJSON(): Excel.Interfaces.AllowEditRangeData;

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

Excel.Interfaces.AllowEditRangeData