Word.SearchOptions class

Пакет:: word

Указывает параметры, которые необходимо включить в операцию поиска. Дополнительные сведения об использовании параметров поиска в API JavaScript Word см. в статье Использование параметров поиска для поиска текста в надстройке Word.

Extends: OfficeExtension.ClientObject

// Search using a wildcard
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Queue a command to search the document with a wildcard
    // for any string of characters that starts with 'to' and ends with 'n'.
    const searchResults = context.document.body.search('to*n', {matchWildcards: true});

    // Queue a command to load the search results and get the font property values.
    searchResults.load('font');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Found count: ' + searchResults.items.length);

    // Queue a set of commands to change the font for each found item.
    for (let i = 0; i < searchResults.items.length; i++) {
        searchResults.items[i].font.color = 'purple';
        searchResults.items[i].font.highlightColor = 'pink';
        searchResults.items[i].font.bold = true;
    }
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
});

Свойства

context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
ignorePunct	Если дано, указывает, следует ли игнорировать все знаки препинания между словами. Значение по умолчанию — `false`. Соответствует полю _Ignore пунктуации characters_ проверка диалоговом окне "Найти и заменить".
ignoreSpace	Если параметр указан, следует ли игнорировать все пробелы между словами. Значение по умолчанию — `false`. Соответствует полю _Ignore пробела characters_ проверка в диалоговом окне "Найти и заменить".
matchCase	Если указано, указывает, следует ли выполнять поиск с учетом регистра. Значение по умолчанию — `false`. Соответствует полю _Match case_ проверка диалогового окна "Найти и заменить".
matchPrefix	Если указано, указывает, нужно ли сопоставлять слова, начинающиеся со строки поиска. Значение по умолчанию — `false`. Соответствует полю _Match prefix_ проверка диалогового окна "Найти и заменить".
matchSuffix	Если указано, указывает, нужно ли сопоставлять слова, которые заканчиваются строкой поиска. Значение по умолчанию — `false`. Соответствует полю _Match suffix_ проверка диалогового окна "Найти и заменить".
matchWholeWord	Если указано, указывает, нужно ли искать только слова целиком, а не текст, который является частью большего слова. Значение по умолчанию — `false`. Соответствует полю _Find слов целиком only_ проверка диалоговом окне "Найти и заменить".
matchWildcards	Указывает, будет ли поиск выполняться с использованием специальных операторов поиска (если указан). Значение по умолчанию — `false`. Соответствует полю _Use wildcards_ проверка в диалоговом окне "Найти и заменить".

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
newObject(context)	Создание нового экземпляра `Word.SearchOptions` объекта.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.SearchOptions` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Word.Interfaces.SearchOptionsData`), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

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

context

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

context: RequestContext;

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

Word.RequestContext

ignorePunct

Если дано, указывает, следует ли игнорировать все знаки препинания между словами. Значение по умолчанию — false. Соответствует полю _Ignore пунктуации characters_ проверка диалоговом окне "Найти и заменить".

ignorePunct: boolean;

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

boolean

ignoreSpace

Если параметр указан, следует ли игнорировать все пробелы между словами. Значение по умолчанию — false. Соответствует полю _Ignore пробела characters_ проверка в диалоговом окне "Найти и заменить".

ignoreSpace: boolean;

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

boolean

matchCase

Если указано, указывает, следует ли выполнять поиск с учетом регистра. Значение по умолчанию — false. Соответствует полю _Match case_ проверка диалогового окна "Найти и заменить".

matchCase: boolean;

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

boolean

matchPrefix

Если указано, указывает, нужно ли сопоставлять слова, начинающиеся со строки поиска. Значение по умолчанию — false. Соответствует полю _Match prefix_ проверка диалогового окна "Найти и заменить".

matchPrefix: boolean;

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

boolean

matchSuffix

Если указано, указывает, нужно ли сопоставлять слова, которые заканчиваются строкой поиска. Значение по умолчанию — false. Соответствует полю _Match suffix_ проверка диалогового окна "Найти и заменить".

matchSuffix: boolean;

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

boolean

matchWholeWord

Если указано, указывает, нужно ли искать только слова целиком, а не текст, который является частью большего слова. Значение по умолчанию — false. Соответствует полю _Find слов целиком only_ проверка диалоговом окне "Найти и заменить".

matchWholeWord: boolean;

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

boolean

matchWildcards

Указывает, будет ли поиск выполняться с использованием специальных операторов поиска (если указан). Значение по умолчанию — false. Соответствует полю _Use wildcards_ проверка в диалоговом окне "Найти и заменить".

matchWildcards: boolean;

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

boolean

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

load(options)

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

load(options?: Word.Interfaces.SearchOptionsLoadOptions): Word.SearchOptions;

Параметры

options: Word.Interfaces.SearchOptionsLoadOptions

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

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

Word.SearchOptions

Примеры

// Ignore punctuation search
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Queue a command to search the document and ignore punctuation.
    const searchResults = context.document.body.search('video you', {ignorePunct: true});

    // Queue a command to load the search results and get the font property values.
    searchResults.load('font');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Found count: ' + searchResults.items.length);

    // Queue a set of commands to change the font for each found item.
    for (let i = 0; i < searchResults.items.length; i++) {
        searchResults.items[i].font.color = 'purple';
        searchResults.items[i].font.highlightColor = '#FFFF00'; //Yellow
        searchResults.items[i].font.bold = true;
    }
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
});

// Search based on a prefix
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Queue a command to search the document based on a prefix.
    const searchResults = context.document.body.search('vid', {matchPrefix: true});

    // Queue a command to load the search results and get the font property values.
    searchResults.load('font');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();

    // Queue a set of commands to change the font for each found item.
    for (let i = 0; i < searchResults.items.length; i++) {
        searchResults.items[i].font.color = 'purple';
        searchResults.items[i].font.highlightColor = '#FFFF00'; //Yellow
        searchResults.items[i].font.bold = true;
    }
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
});

// Search based on a suffix
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to search the document for any string of characters after 'ly'.
    const searchResults = context.document.body.search('ly', {matchSuffix: true});

    // Queue a command to load the search results and get the font property values.
    searchResults.load('font');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Found count: ' + searchResults.items.length);

    // Queue a set of commands to change the font for each found item.
    for (let i = 0; i < searchResults.items.length; i++) {
        searchResults.items[i].font.color = 'orange';
        searchResults.items[i].font.highlightColor = 'black';
        searchResults.items[i].font.bold = true;
    }
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
});

// Search using a wildcard
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Queue a command to search the document with a wildcard
    // for any string of characters that starts with 'to' and ends with 'n'.
    const searchResults = context.document.body.search('to*n', {matchWildcards: true});

    // Queue a command to load the search results and get the font property values.
    searchResults.load('font');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Found count: ' + searchResults.items.length);

    // Queue a set of commands to change the font for each found item.
    for (let i = 0; i < searchResults.items.length; i++) {
        searchResults.items[i].font.color = 'purple';
        searchResults.items[i].font.highlightColor = 'pink';
        searchResults.items[i].font.bold = true;
    }
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
});

load(propertyNames)

load(propertyNames?: string | string[]): Word.SearchOptions;

Параметры

propertyNames: string | string[]

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

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

Word.SearchOptions

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.SearchOptions;

Параметры

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

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

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

Word.SearchOptions

newObject(context)

Создание нового экземпляра Word.SearchOptions объекта.

static newObject(context: OfficeExtension.ClientRequestContext): Word.SearchOptions;

Параметры

context: OfficeExtension.ClientRequestContext

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

Word.SearchOptions

set(properties, options)

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

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

Параметры

properties: Word.Interfaces.SearchOptionsUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Word.SearchOptions): void;

Параметры

properties: Word.SearchOptions

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

void

toJSON()

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

toJSON(): Word.Interfaces.SearchOptionsData;

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

Word.Interfaces.SearchOptionsData

Обратная связь

Были ли сведения на этой странице полезными?

Word.SearchOptions class

Комментарии

Используется

Примеры

Свойства

Методы

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

context

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

ignorePunct

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

Комментарии

ignoreSpace

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

Комментарии

matchCase

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

Комментарии

matchPrefix

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

Комментарии

matchSuffix

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

Комментарии

matchWholeWord

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

Комментарии

matchWildcards

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

Комментарии

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

load(options)

Параметры

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

Примеры

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

newObject(context)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

Обратная связь