Excel.Style class
スタイルの書式とその他のプロパティをカプセル化するオブジェクト。
- Extends
注釈
[API セット: ExcelApi 1.7]
プロパティ
| auto |
セル内のテキストの配置が等分散に設定されている場合に、テキストを自動的にインデントするかどうかを指定します。 |
| borders | 4 つの罫線のスタイルを表す 4 つの罫線オブジェクトのコレクション。 |
| built |
スタイルが組み込みスタイルかどうかを指定します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| fill | スタイルの塗りつぶし。 |
| font | スタイルのフォントを表す |
| formula |
ワークシートが保護されているときに数式を非表示にするかどうかを指定します。 |
| horizontal |
スタイルでの水平方向の配置を表します。 詳細は「 |
| include |
スタイルに自動インデント、水平方向の配置、垂直方向の配置、文字列の折り返し、インデント レベル、およびテキスト方向のプロパティを含めるかどうかを指定します。 |
| include |
スタイルにカラー、カラー インデックス、線のスタイル、および太さの罫線プロパティを含めるかどうかを指定します。 |
| include |
スタイルに background、bold、color、color index、font style、italic、name、size、strikethrough、subscript、upscript、underline font プロパティを含めるかどうかを指定します。 |
| include |
スタイルに数値の書式プロパティが含まれているかどうかを指定します。 |
| include |
スタイルにカラー、カラー インデックス、負の場合は反転、パターン、パターン カラー、およびパターン カラー インデックスの内部プロパティを含めるかどうかを指定します。 |
| include |
隠し保護プロパティとロック保護プロパティの数式がスタイルに含まれるかどうかを指定します。 |
| indent |
スタイルのインデント レベルを示す 0 から 250 の範囲内の整数。 |
| locked | ワークシートが保護されているときにオブジェクトがロックされているかどうかを指定します。 |
| name | スタイルの名前。 |
| number |
スタイルで適用される数値形式の表示形式コード。 |
| number |
スタイルで適用される数値形式のローカライズされた表示形式コード。 |
| reading |
スタイルで適用される読み上げ順序。 |
| shrink |
使用可能な列幅に合わせてテキストを自動的に縮小するかどうかを指定します。 |
| text |
スタイルで適用されるテキストの向き。 |
| vertical |
スタイルの垂直方向の配置を指定します。 詳細は「 |
| wrap |
Excel がオブジェクト内のテキストを折り返すかどうかを指定します。 |
メソッド
| delete() | このスタイルを削除します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
autoIndent
セル内のテキストの配置が等分散に設定されている場合に、テキストを自動的にインデントするかどうかを指定します。
autoIndent: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.8]
borders
4 つの罫線のスタイルを表す 4 つの罫線オブジェクトのコレクション。
readonly borders: Excel.RangeBorderCollection;
プロパティ値
注釈
[API セット: ExcelApi 1.7]
builtIn
スタイルが組み込みスタイルかどうかを指定します。
readonly builtIn: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.7]
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
fill
font
スタイルのフォントを表す Font オブジェクト。
readonly font: Excel.RangeFont;
プロパティ値
注釈
[API セット: ExcelApi 1.7]
formulaHidden
ワークシートが保護されているときに数式を非表示にするかどうかを指定します。
formulaHidden: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.7]
horizontalAlignment
スタイルでの水平方向の配置を表します。 詳細は「Excel.HorizontalAlignment」をご覧ください。
horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";
プロパティ値
Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"
注釈
[API セット: ExcelApi 1.7]
includeAlignment
スタイルに自動インデント、水平方向の配置、垂直方向の配置、文字列の折り返し、インデント レベル、およびテキスト方向のプロパティを含めるかどうかを指定します。
includeAlignment: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.7]
includeBorder
スタイルにカラー、カラー インデックス、線のスタイル、および太さの罫線プロパティを含めるかどうかを指定します。
includeBorder: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.7]
includeFont
スタイルに background、bold、color、color index、font style、italic、name、size、strikethrough、subscript、upscript、underline font プロパティを含めるかどうかを指定します。
includeFont: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.7]
includeNumber
スタイルに数値の書式プロパティが含まれているかどうかを指定します。
includeNumber: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.7]
includePatterns
スタイルにカラー、カラー インデックス、負の場合は反転、パターン、パターン カラー、およびパターン カラー インデックスの内部プロパティを含めるかどうかを指定します。
includePatterns: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.7]
includeProtection
隠し保護プロパティとロック保護プロパティの数式がスタイルに含まれるかどうかを指定します。
includeProtection: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.7]
indentLevel
スタイルのインデント レベルを示す 0 から 250 の範囲内の整数。
indentLevel: number;
プロパティ値
number
注釈
[API セット: ExcelApi 1.7]
locked
ワークシートが保護されているときにオブジェクトがロックされているかどうかを指定します。
locked: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.7]
name
スタイルの名前。
readonly name: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.7]
numberFormat
スタイルで適用される数値形式の表示形式コード。
numberFormat: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.7]
numberFormatLocal
スタイルで適用される数値形式のローカライズされた表示形式コード。
numberFormatLocal: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.7]
readingOrder
スタイルで適用される読み上げ順序。
readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";
プロパティ値
Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"
注釈
[API セット: ExcelApi 1.7]
shrinkToFit
使用可能な列幅に合わせてテキストを自動的に縮小するかどうかを指定します。
shrinkToFit: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.7]
textOrientation
スタイルで適用されるテキストの向き。
textOrientation: number;
プロパティ値
number
注釈
[API セット: ExcelApi 1.8]
verticalAlignment
スタイルの垂直方向の配置を指定します。 詳細は「Excel.VerticalAlignment」をご覧ください。
verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";
プロパティ値
Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"
注釈
[API セット: ExcelApi 1.7]
wrapText
Excel がオブジェクト内のテキストを折り返すかどうかを指定します。
wrapText: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.7]
メソッドの詳細
delete()
このスタイルを削除します。
delete(): void;
返品
void
注釈
[API セット: ExcelApi 1.7]
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.StyleLoadOptions): Excel.Style;
パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.Style;
パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Style;
パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.StyleUpdateData, options?: OfficeExtension.UpdateOptions): void;
パラメーター
- properties
- Excel.Interfaces.StyleUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.Style): void;
パラメーター
- properties
- Excel.Style
返品
void
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Style オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.StyleData と型指定) を返します。
toJSON(): Excel.Interfaces.StyleData;