Word.DatePickerContentControl class
DatePickerContentControl オブジェクトを表します。
- Extends
注釈
使用元
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-date-picker-content-control.yaml
// Gets and logs the properties of the first date picker content control.
await Word.run(async (context) => {
let contentControls = context.document.getContentControls({
types: [Word.ContentControlType.datePicker]
});
contentControls.load("items");
await context.sync();
if (contentControls.items.length === 0) {
console.warn("No date picker content controls found in the document.");
return;
}
const firstControl = contentControls.items[0];
firstControl.load("datePickerContentControl");
await context.sync();
const datePicker: Word.DatePickerContentControl = firstControl.datePickerContentControl;
datePicker.load("dateCalendarType, dateDisplayFormat, dateDisplayLocale, dateStorageFormat");
await context.sync();
console.log("Date picker content control properties:");
console.log(" Calendar type: " + datePicker.dateCalendarType);
console.log(" Display format: " + datePicker.dateDisplayFormat);
console.log(" Display locale: " + datePicker.dateDisplayLocale);
console.log(" Storage format: " + datePicker.dateStorageFormat);
});
プロパティ
| appearance | コンテンツ コントロールの外観を指定します。 |
| color | コンテンツ コントロールの色の赤/緑-青 (RGB) 値を指定します。 値は '#RRGGBB' 形式で指定できます。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| date |
日付選択コンテンツ コントロールの予定表の種類を表す |
| date |
日付を表示する形式を指定します。 |
| date |
日付選択コンテンツ コントロールに表示される日付の言語形式を表す |
| date |
日付選択コンテンツ コントロールがアクティブなドキュメントの XML データ ストアにバインドされている場合に、日付の保存と取得の形式を表す |
| id | コンテンツ コントロールの ID を取得します。 |
| is |
ユーザーがコントロールの内容を編集するときに、そのコンテンツ コントロールをアクティブ ドキュメントから削除するかどうかを指定します。 |
| level | コンテンツ コントロールのレベル (コンテンツ コントロールでテキスト、段落、表のセル、表の行のいずれを囲むか) を指定します。またはインラインの場合。 |
| lock |
コンテンツ コントロールがロックされている (削除できない) かどうかを指定します。
|
| lock |
コンテンツ コントロールのコンテンツをロックする (編集できない) かどうかを指定します。
|
| placeholder |
コンテンツ コントロールのプレースホルダー テキストを表す |
| range | 作業中のドキュメント内のコンテンツ コントロールの内容を表す |
| showing |
コンテンツ コントロールのプレースホルダー テキストが表示されているかどうかを取得します。 |
| tag | コンテンツ コントロールを識別するためのタグを指定します。 |
| title | コンテンツ コントロールのタイトルを指定します。 |
| xml |
ドキュメントのデータ ストア内の XML データへのコンテンツ コントロールのマッピングを表す |
メソッド
| copy() | 作業中の文書のコンテンツ コントロールをクリップボードにコピーします。 |
| cut() | 作業中の文書からコンテンツ コントロールを削除し、コンテンツ コントロールをクリップボードに移動します。 |
| delete(delete |
このコンテンツ コントロールとコンテンツ コントロールのコンテンツを削除します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| set |
ユーザーが独自の文字列を入力するまでコンテンツ コントロールに表示されるプレースホルダー文字列を設定します。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 |
プロパティの詳細
appearance
コンテンツ コントロールの外観を指定します。
appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";プロパティ値
Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"
注釈
color
コンテンツ コントロールの色の赤/緑-青 (RGB) 値を指定します。 値は '#RRGGBB' 形式で指定できます。
color: string;プロパティ値
string
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: 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"
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-date-picker-content-control.yaml
function changeCalendarType(datePicker: Word.DatePickerContentControl) {
// The calendar type can only be set to a value compatible with the display locale.
// For the Japanese locale, valid calendar types are Gregorian and Japan.
datePicker.dateCalendarType = Word.CalendarType.japan;
}
dateDisplayFormat
日付を表示する形式を指定します。
dateDisplayFormat: string;プロパティ値
string
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-date-picker-content-control.yaml
function changeDisplayFormat(datePicker: Word.DatePickerContentControl) {
// Set the display format.
datePicker.dateDisplayFormat = "yyyy/MM/dd";
}
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"
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-date-picker-content-control.yaml
function changeCalendarLanguage(datePicker: Word.DatePickerContentControl) {
// Set the display locale before changing the calendar type, since calendar type must be compatible with the locale.
datePicker.dateDisplayLocale = Word.LanguageId.japanese;
}
dateStorageFormat
日付選択コンテンツ コントロールがアクティブなドキュメントの XML データ ストアにバインドされている場合に、日付の保存と取得の形式を表す ContentControlDateStorageFormat 値を指定します。
dateStorageFormat: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime";プロパティ値
Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-date-picker-content-control.yaml
function changeStorageFormat(datePicker: Word.DatePickerContentControl) {
// Set the storage format to DateTime, which means the date and time will be stored in ISO format (e.g., "2024-12-31T23:59:00Z").
// The time portion will be ignored when getting/setting the value of the content control, since it's a date picker.
datePicker.dateStorageFormat = Word.ContentControlDateStorageFormat.dateTime;
}
id
isTemporary
ユーザーがコントロールの内容を編集するときに、そのコンテンツ コントロールをアクティブ ドキュメントから削除するかどうかを指定します。
isTemporary: boolean;プロパティ値
boolean
注釈
level
コンテンツ コントロールのレベル (コンテンツ コントロールでテキスト、段落、表のセル、表の行のいずれを囲むか) を指定します。またはインラインの場合。
readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell";プロパティ値
Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"
注釈
lockContentControl
コンテンツ コントロールがロックされている (削除できない) かどうかを指定します。
true は、ユーザーがアクティブなドキュメントから削除できないことを意味します false 、削除できることを意味します。
lockContentControl: boolean;プロパティ値
boolean
注釈
lockContents
コンテンツ コントロールのコンテンツをロックする (編集できない) かどうかを指定します。
true は、ユーザーがコンテンツを編集できないことを意味します false 、コンテンツが編集可能であることを意味します。
lockContents: boolean;プロパティ値
boolean
注釈
placeholderText
コンテンツ コントロールのプレースホルダー テキストを表す BuildingBlock オブジェクトを返します。
readonly placeholderText: Word.BuildingBlock;プロパティ値
注釈
range
作業中のドキュメント内のコンテンツ コントロールの内容を表す Range オブジェクトを取得します。
readonly range: Word.Range;プロパティ値
注釈
showingPlaceholderText
コンテンツ コントロールのプレースホルダー テキストが表示されているかどうかを取得します。
readonly showingPlaceholderText: boolean;プロパティ値
boolean
注釈
tag
title
xmlMapping
ドキュメントのデータ ストア内の XML データへのコンテンツ コントロールのマッピングを表す XmlMapping オブジェクトを取得します。
readonly xmlMapping: Word.XmlMapping;プロパティ値
注釈
メソッドの詳細
copy()
cut()
作業中の文書からコンテンツ コントロールを削除し、コンテンツ コントロールをクリップボードに移動します。
cut(): void;返品
void
注釈
delete(deleteContents)
このコンテンツ コントロールとコンテンツ コントロールのコンテンツを削除します。
delete(deleteContents?: boolean): void;パラメーター
- deleteContents
-
boolean
省略可能。
true
の場合は、コンテンツも削除します。
返品
void
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.DatePickerContentControlLoadOptions): Word.DatePickerContentControl;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.DatePickerContentControl;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.DatePickerContentControl;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.DatePickerContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.DatePickerContentControl): void;パラメーター
- properties
- Word.DatePickerContentControl
返品
void
setPlaceholderText(options)
ユーザーが独自の文字列を入力するまでコンテンツ コントロールに表示されるプレースホルダー文字列を設定します。
setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void;パラメーター
省略可能。 コンテンツ コントロールのプレースホルダー テキストを構成するためのオプション。
返品
void
注釈
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.DatePickerContentControl オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.DatePickerContentControlData と型指定) を返します。
toJSON(): Word.Interfaces.DatePickerContentControlData;返品
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.DatePickerContentControl;返品
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。
untrack(): Word.DatePickerContentControl;