Word.DatePickerContentControl class

指定内容控件的外观。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定内容控件颜色的红-绿-蓝 (RGB) 值。 可以采用“#RRGGBB”格式提供值。

color: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

指定一个 CalendarType 值，该值表示日期选取器内容控件的日历类型。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定显示日期的格式。

dateDisplayFormat: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定表示 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";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定一个 ContentControlDateStorageFormat 值，该值表示在日期选取器内容控件绑定到活动文档的 XML 数据存储时用于存储和检索日期的格式。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取内容控件的标识。

readonly id: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定当用户编辑控件的内容时是否从活动文档中删除内容控件。

isTemporary: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定内容控件的级别 - 内容控件是围绕文本、段落、表单元格还是表行;或内联时。

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

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定内容控件是否锁定 (无法) 删除。 true 表示用户无法从活动文档中删除它， false 表示可以将其删除。

lockContentControl: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定内容控件的内容是否锁定 (不可编辑) 。 true 表示用户无法编辑内容， false 表示内容可编辑。

lockContents: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回一个 BuildingBlock 对象，该对象代表内容控件的占位符文本。

readonly placeholderText: Word.BuildingBlock;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取一个 Range 对象，该对象表示活动文档中的内容控件的内容。

readonly range: Word.Range;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取是否显示内容控件的占位符文本。

readonly showingPlaceholderText: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定用于标识内容控件的标记。

tag: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定内容控件的标题。

title: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取一个 XmlMapping 对象，该对象表示内容控件到文档数据存储中的 XML 数据的映射。

readonly xmlMapping: Word.XmlMapping;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

将活动文档中的内容控件复制到剪贴板。

copy(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

从活动文档中删除内容控件并将该内容控件移动到剪贴板中。

cut(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

删除此内容控件和内容控件的内容。

delete(deleteContents?: boolean): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

返回

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

返回

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

返回

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

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

参数

返回

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Word.DatePickerContentControl): void;

参数

返回

设置在用户输入自己的文本之前显示在内容控件中的占位符文本。

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

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.DatePickerContentControl对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.DatePickerContentControlData) ，其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Word.Interfaces.DatePickerContentControlData;

返回

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.DatePickerContentControl;

返回

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.DatePickerContentControl;

返回