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


Excel.DataValidation class

Представляет проверку данных, применяемую к текущему диапазону. Дополнительные сведения о объектной модели проверки данных см. в статье Добавление проверки данных в диапазоны Excel.

Extends

Комментарии

[ Набор API: ExcelApi 1.8 ]

Свойства

context

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

errorAlert

Сообщение об ошибке, когда пользователь вводит недопустимые данные.

ignoreBlanks

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

prompt

Запрашивать, когда пользователи выбирают ячейку.

rule

Правило проверки данных, содержащее различные типы критериев проверки данных.

type

Тип проверки данных см Excel.DataValidationType . дополнительные сведения.

valid

Указывает, являются ли все значения ячеек допустимыми в соответствии с правилами проверки данных. Возвращает значение true , если все значения ячеек являются допустимыми или false если все значения ячеек недопустимы. Возвращает значение null , если в диапазоне имеются допустимые и недопустимые значения ячеек.

Методы

clear()

Очищает проверку данных из текущего диапазона.

getInvalidCells()

Возвращает объект, состоящий RangeAreas из одного или нескольких прямоугольных диапазонов, с недопустимыми значениями ячеек. Если все значения ячеек допустимы, эта функция выдает ошибку ItemNotFound .

getInvalidCellsOrNullObject()

Возвращает объект, состоящий RangeAreas из одного или нескольких прямоугольных диапазонов, с недопустимыми значениями ячеек. Если все значения ячеек допустимы, эта функция вернет null.

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.DataValidation объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.DataValidationData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

context

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

context: RequestContext;

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

errorAlert

Сообщение об ошибке, когда пользователь вводит недопустимые данные.

errorAlert: Excel.DataValidationErrorAlert;

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

Комментарии

[ Набор API: ExcelApi 1.8 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Decision");
    const commentsRange = 
        sheet.tables.getItem("NameOptionsTable").columns.getItem("Comments").getDataBodyRange();

    // When you are developing, it is a good practice to
    // clear the dataValidation object with each run of your code.
    commentsRange.dataValidation.clear();   

    // If the value of A2 is contained in the value of C2, then 
    // SEARCH(A2,C2) returns the number where it begins. Otherwise,
    // it does not return a number.
    let redundantStringRule = {
        custom: {
            formula: "=NOT(ISNUMBER(SEARCH(A2,C2)))"
        }
    };
    commentsRange.dataValidation.rule = redundantStringRule;
    commentsRange.dataValidation.errorAlert = {
        message: "It is redundant to include the baby name in the comment.",
        showAlert: true,
        style: "Information",
        title: "Baby Name in Comment"
    };

    await context.sync();
});

ignoreBlanks

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

ignoreBlanks: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.8 ]

prompt

Запрашивать, когда пользователи выбирают ячейку.

prompt: Excel.DataValidationPrompt;

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

Комментарии

[ Набор API: ExcelApi 1.8 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Decision");
    const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange();

    // When you are developing, it is a good practice to
    // clear the dataValidation object with each run of your code.
    rankingRange.dataValidation.clear();

    let greaterThanZeroRule = {
        wholeNumber: {
            formula1: 0,
            operator: Excel.DataValidationOperator.greaterThan
        }
    };
    rankingRange.dataValidation.rule = greaterThanZeroRule;

    rankingRange.dataValidation.prompt = {
        message: "Please enter a positive number.",
        showPrompt: true,
        title: "Positive numbers only."
    };

    rankingRange.dataValidation.errorAlert = {
        message: "Sorry, only positive numbers are allowed",
        showAlert: true,
        style: "Stop",
        title: "Negative Number Entered"
    };

    await context.sync();
});

rule

Правило проверки данных, содержащее различные типы критериев проверки данных.

rule: Excel.DataValidationRule;

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

Комментарии

[ Набор API: ExcelApi 1.8 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Decision");
    const nameRange = 
        sheet.tables.getItem("NameOptionsTable").columns.getItem("Baby Name").getDataBodyRange();

    // When you are developing, it is a good practice to
    // clear the dataValidation object with each run of your code.
    nameRange.dataValidation.clear();

    const nameSourceRange = context.workbook.worksheets.getItem("Names").getRange("A1:A3");

    let approvedListRule = {
        list: {
            inCellDropDown: true,
            source: nameSourceRange
        }
    };
    nameRange.dataValidation.rule = approvedListRule;

    await context.sync();
});

type

Тип проверки данных см Excel.DataValidationType . дополнительные сведения.

readonly type: Excel.DataValidationType | "None" | "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | "Custom" | "Inconsistent" | "MixedCriteria";

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

Excel.DataValidationType | "None" | "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | "Custom" | "Inconsistent" | "MixedCriteria"

Комментарии

[ Набор API: ExcelApi 1.8 ]

valid

Указывает, являются ли все значения ячеек допустимыми в соответствии с правилами проверки данных. Возвращает значение true , если все значения ячеек являются допустимыми или false если все значения ячеек недопустимы. Возвращает значение null , если в диапазоне имеются допустимые и недопустимые значения ячеек.

readonly valid: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.8 ]

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

clear()

Очищает проверку данных из текущего диапазона.

clear(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.8 ]

getInvalidCells()

Возвращает объект, состоящий RangeAreas из одного или нескольких прямоугольных диапазонов, с недопустимыми значениями ячеек. Если все значения ячеек допустимы, эта функция выдает ошибку ItemNotFound .

getInvalidCells(): Excel.RangeAreas;

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

Комментарии

[ Набор API: ExcelApi 1.9 ]

getInvalidCellsOrNullObject()

Возвращает объект, состоящий RangeAreas из одного или нескольких прямоугольных диапазонов, с недопустимыми значениями ячеек. Если все значения ячеек допустимы, эта функция вернет null.

getInvalidCellsOrNullObject(): Excel.RangeAreas;

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

Комментарии

[ Набор API: ExcelApi 1.9 ]

load(options)

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

load(options?: Excel.Interfaces.DataValidationLoadOptions): Excel.DataValidation;

Параметры

options
Excel.Interfaces.DataValidationLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

set(properties, options)

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

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

Параметры

properties
Excel.Interfaces.DataValidationUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.DataValidation): void;

Параметры

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

void

toJSON()

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

toJSON(): Excel.Interfaces.DataValidationData;

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