Excel.ShapeLineFormat class
図形オブジェクトの線の書式を表します。 画像と幾何学的図形の場合、線の書式設定は図形の境界線を表します。
- Extends
注釈
プロパティ
| color | #RRGGBB 形式 ("FFA500" など) または名前付き HTML の色 (例: "オレンジ") の形式で、行の色を HTML 色形式で表します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| dash |
図形の線スタイルを表します。 線が表示されていない場合、または一貫性のないダッシュ スタイルがある場合に |
| style | 図形の線スタイルを表します。 線が表示されていない場合、またはスタイルに一貫性がない場合に |
| transparency | 指定された線の透明度を示す 0.0 (不透明) から 1.0 (透明) までの値を表します。 図形に一貫性のないトランスパレンシーがある場合に |
| visible | 図形要素の線の書式を表示するかどうかを指定します。 図形に一貫性のない可視性がある場合に |
| weight | 線の太さ (ポイント数) を表します。 線が表示されない場合、または線の太さが一致しない場合に |
メソッド
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
color
#RRGGBB 形式 ("FFA500" など) または名前付き HTML の色 (例: "オレンジ") の形式で、行の色を HTML 色形式で表します。
color: string;プロパティ値
string
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
dashStyle
図形の線スタイルを表します。 線が表示されていない場合、または一貫性のないダッシュ スタイルがある場合に null を返します。 詳細は「Excel.ShapeLineDashStyle」をご覧ください。
dashStyle: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";プロパティ値
Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"
注釈
style
図形の線スタイルを表します。 線が表示されていない場合、またはスタイルに一貫性がない場合に null を返します。 詳細は「Excel.ShapeLineStyle」をご覧ください。
style: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";プロパティ値
Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"
注釈
transparency
指定された線の透明度を示す 0.0 (不透明) から 1.0 (透明) までの値を表します。 図形に一貫性のないトランスパレンシーがある場合に null を返します。
transparency: number;プロパティ値
number
注釈
visible
図形要素の線の書式を表示するかどうかを指定します。 図形に一貫性のない可視性がある場合に null を返します。
visible: boolean;プロパティ値
boolean
注釈
weight
線の太さ (ポイント数) を表します。 線が表示されない場合、または線の太さが一致しない場合に null を返します。
weight: number;プロパティ値
number
注釈
メソッドの詳細
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.ShapeLineFormatLoadOptions): Excel.ShapeLineFormat;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.ShapeLineFormat;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ShapeLineFormat;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.ShapeLineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.ShapeLineFormatUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.ShapeLineFormat): void;パラメーター
- properties
- Excel.ShapeLineFormat
戻り値
void
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.ShapeLineFormat オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ShapeLineFormatData として型指定) を返します。
toJSON(): Excel.Interfaces.ShapeLineFormatData;戻り値
Office Add-ins