Word.DatePickerContentControl class
DatePickerContentControl オブジェクトを表します。
- Extends
注釈
プロパティ
| 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"
注釈
dateDisplayFormat
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"
注釈
dateStorageFormat
日付ピッカー コンテンツ コントロールが作業中のドキュメントの XML データ ストアにバインドされている場合の日付の保存と取得の形式を表す ContentControlDateStorageFormat 値を指定します。
dateStorageFormat: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime";
プロパティ値
Word.ContentControlDateStorageFormat | "Text" | "Date" | "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
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
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;