Word.DatePickerContentControl class

Пакет:

word

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

Свойства

appearance	Указывает внешний вид элемента управления содержимым.
color	Задает значение цвета элемента управления содержимым в формате RGB. Можно указать значение в формате "#RRGGBB".
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
dateCalendarType	Задает CalendarType значение, представляющее тип календаря для элемента управления содержимым средства выбора даты.
dateDisplayFormat	Указывает формат, в котором отображаются даты.
dateDisplayLocale	Указывает LanguageId , представляющий языковой формат даты, отображаемой в элементе управления содержимым средства выбора даты.
dateStorageFormat	Задает ContentControlDateStorageFormat значение, представляющее формат для хранения и получения дат, когда элемент управления содержимым средства выбора даты привязан к хранилищу данных XML активного документа.
id	Возвращает идентификацию элемента управления содержимым.
isTemporary	Указывает, следует ли удалять элемент управления содержимым из активного документа, когда пользователь изменяет содержимое элемента управления.
level	Указывает уровень элемента управления содержимым— окружает ли элемент управления содержимым текст, абзацы, ячейки таблицы или строки таблицы; или, если он является встроенным.
lockContentControl	Указывает, заблокирован ли элемент управления содержимым (его невозможно удалить). true означает, что пользователь не может удалить его из активного документа, false то есть его можно удалить.
lockContents	Указывает, заблокировано ли содержимое элемента управления содержимым (невозможно изменить). true означает, что пользователь не может изменить содержимое, означает, false что содержимое является редактируемым.
placeholderText	BuildingBlock Возвращает объект , представляющий текст заполнителя для элемента управления содержимым.
range	Range Возвращает объект , представляющий содержимое элемента управления содержимым в активном документе.
showingPlaceholderText	Возвращает значение, указывающее, отображается ли замещающий текст для элемента управления содержимым.
tag	Указывает тег для идентификации элемента управления содержимым.
title	Задает заголовок элемента управления содержимым.
xmlMapping	XmlMapping Возвращает объект , представляющий сопоставление элемента управления содержимым с XML-данными в хранилище данных документа.

Методы

copy()	Копирует элемент управления содержимым из активного документа в буфер обмена.
cut()	Удаляет элемент управления содержимым из активного документа и перемещает его в буфер обмена.
delete(deleteContents)	Удаляет этот элемент управления содержимым и содержимое элемента управления содержимым.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setPlaceholderText(options)	Задает текст-заполнитель, который отображается в элементе управления содержимым до тех пор, пока пользователь не введет свой собственный текст.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.DatePickerContentControl объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.DatePickerContentControlData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

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

appearance

Указывает внешний вид элемента управления содержимым.

appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";

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

Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

color

Задает значение цвета элемента управления содержимым в формате RGB. Можно указать значение в формате "#RRGGBB".

color: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

context

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

context: RequestContext;

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

Word.RequestContext

dateCalendarType

Задает CalendarType значение, представляющее тип календаря для элемента управления содержимым средства выбора даты.

dateCalendarType: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura";

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

Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

dateDisplayFormat

Указывает формат, в котором отображаются даты.

dateDisplayFormat: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

dateDisplayLocale

Указывает LanguageId , представляющий языковой формат даты, отображаемой в элементе управления содержимым средства выбора даты.

dateDisplayLocale: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu";

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

Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

dateStorageFormat

Задает ContentControlDateStorageFormat значение, представляющее формат для хранения и получения дат, когда элемент управления содержимым средства выбора даты привязан к хранилищу данных XML активного документа.

dateStorageFormat: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime";

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

Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

id

Возвращает идентификацию элемента управления содержимым.

readonly id: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

isTemporary

Указывает, следует ли удалять элемент управления содержимым из активного документа, когда пользователь изменяет содержимое элемента управления.

isTemporary: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

level

Указывает уровень элемента управления содержимым— окружает ли элемент управления содержимым текст, абзацы, ячейки таблицы или строки таблицы; или, если он является встроенным.

readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell";

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

Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

lockContentControl

Указывает, заблокирован ли элемент управления содержимым (его невозможно удалить). true означает, что пользователь не может удалить его из активного документа, false то есть его можно удалить.

lockContentControl: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

lockContents

Указывает, заблокировано ли содержимое элемента управления содержимым (невозможно изменить). true означает, что пользователь не может изменить содержимое, означает, false что содержимое является редактируемым.

lockContents: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

placeholderText

BuildingBlock Возвращает объект , представляющий текст заполнителя для элемента управления содержимым.

readonly placeholderText: Word.BuildingBlock;

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

Word.BuildingBlock

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

range

Range Возвращает объект , представляющий содержимое элемента управления содержимым в активном документе.

readonly range: Word.Range;

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

Word.Range

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

showingPlaceholderText

Возвращает значение, указывающее, отображается ли замещающий текст для элемента управления содержимым.

readonly showingPlaceholderText: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

tag

Указывает тег для идентификации элемента управления содержимым.

tag: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

title

Задает заголовок элемента управления содержимым.

title: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

xmlMapping

XmlMapping Возвращает объект , представляющий сопоставление элемента управления содержимым с XML-данными в хранилище данных документа.

readonly xmlMapping: Word.XmlMapping;

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

Word.XmlMapping

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

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

copy()

Копирует элемент управления содержимым из активного документа в буфер обмена.

copy(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

cut()

Удаляет элемент управления содержимым из активного документа и перемещает его в буфер обмена.

cut(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

delete(deleteContents)

Удаляет этот элемент управления содержимым и содержимое элемента управления содержимым.

delete(deleteContents?: boolean): void;

Параметры

deleteContents

boolean

Необязательный параметр. Если trueзначение , также удаляет содержимое.

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

void

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

load(options)

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

load(options?: Word.Interfaces.DatePickerContentControlLoadOptions): Word.DatePickerContentControl;

Параметры

options

Word.Interfaces.DatePickerContentControlLoadOptions

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

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

Word.DatePickerContentControl

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.DatePickerContentControl

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Word.DatePickerContentControl

set(properties, options)

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

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

Параметры

properties

Word.Interfaces.DatePickerContentControlUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Word.DatePickerContentControl): void;

Параметры

properties

Word.DatePickerContentControl

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

void

setPlaceholderText(options)

Задает текст-заполнитель, который отображается в элементе управления содержимым до тех пор, пока пользователь не введет свой собственный текст.

setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void;

Параметры

options

Word.ContentControlPlaceholderOptions

Необязательный параметр. Параметры для настройки замещающего текста элемента управления содержимым.

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

void

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

toJSON()

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

toJSON(): Word.Interfaces.DatePickerContentControlData;

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

Word.Interfaces.DatePickerContentControlData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.

track(): Word.DatePickerContentControl;

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

Word.DatePickerContentControl

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): Word.DatePickerContentControl;

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

Word.DatePickerContentControl