- GC.Data
- GC.Pivot
- GC.Spread.Pivot
- GC.Spread.Slicers
- GC.Spread.CalcEngine
- GC.Spread.Commands
- GC.Spread.Common
- GC.Spread.Formatter
- GC.Spread.Report
- GC.Spread.Sheets
- GC.Spread.Sheets.IO
- GC.Spread.Sheets.AutoMerge
- GC.Spread.Sheets.Barcode
- GC.Spread.Sheets.Bindings
- GC.Spread.Sheets.CalcEngine
- GC.Spread.Sheets.Search
- GC.Spread.Sheets.CellState
- GC.Spread.Sheets.CellTypes
- GC.Spread.Sheets.Charts
- GC.Spread.Sheets.Commands
- GC.Spread.Sheets.Comments
- GC.Spread.Sheets.ConditionalFormatting
- GC.Spread.Sheets.ContextMenu
- GC.Spread.Sheets.DataValidation
- GC.Spread.Sheets.Fill
- GC.Spread.Sheets.Filter
- GC.Spread.Sheets.FloatingObjects
- GC.Spread.Sheets.FormulaTextBox
- GC.Spread.Sheets.FormulaPanel
- GC.Spread.Sheets.Hyperlink
- GC.Spread.Sheets.InputMask
- GC.Spread.Sheets.NameBox
- GC.Spread.Sheets.OutlineColumn
- GC.Spread.Sheets.Outlines
- GC.Spread.Sheets.PDF
- GC.Spread.Sheets.Print
- GC.Spread.Sheets.Shapes
- GC.Spread.Sheets.Slicers
- GC.Spread.Sheets.Sparklines
- GC.Spread.Sheets.StatusBar
- GC.Spread.Sheets.Tables
- GC.Spread.Sheets.TableSheet
- GC.Spread.Sheets.GanttSheet
- GC.Spread.Sheets.Touch
- GC.Spread.Sheets.Designer
- GC.Spread.Excel
GC.Spread.Sheets.Comments.Comment
クラス: Comment
Table of contents
コンストラクタ
メソッド
- autoSize
- backColor
- borderColor
- borderStyle
- borderWidth
- commentState
- displayMode
- dynamicMove
- dynamicSize
- fontFamily
- fontSize
- fontStyle
- fontWeight
- foreColor
- height
- horizontalAlign
- indicatorColor
- indicatorSize
- location
- lockText
- locked
- opacity
- padding
- showShadow
- text
- textDecoration
- width
- zIndex
コンストラクタ
constructor
• new Comment(text?)
コメントを表します。
実例
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.autoSize(true);
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 |
|---|---|
text? |
string |
メソッド
autoSize
▸ autoSize(value?): any
コメントのサイズをその内容に基づいて自動的に設定するかどうかを取得または設定します。
実例
// 次のサンプルコードは、autoSizeメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.autoSize(true);
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
コメントのサイズを自動的に設定するかどうか。 |
戻り値
any
値が設定されていない場合は、コメントのサイズを自動的に設定するかどうかを返します。値が設定されている場合は、コメントを返します。
backColor
▸ backColor(value?): any
コメントの背景色を取得または設定します。
実例
// 次のサンプルコードは、backColorメソッドを設定します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
string |
コメントの背景色。 |
戻り値
any
値が設定されていない場合は、コメントの背景色を返します。値が設定されている場合は、コメントを返します。
borderColor
▸ borderColor(value?): any
コメントの境界線の色を取得または設定します。
実例
// 次のサンプルコードは、borderColorメソッドを設定します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.borderWidth(2);
comment.borderStyle("dotted");
comment.borderColor("red");
activeSheet.getCell(5,5).comment(comment);
activeSheet.suspendPaint();
activeSheet.resumePaint();
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
string |
コメントの境界線の色。 |
戻り値
any
値が設定されていない場合は、コメントの境界線の色を返します。値が設定されている場合は、コメントを返します。
borderStyle
▸ borderStyle(value?): any
コメントの境界線スタイルを取得または設定します。
実例
// 次のサンプルコードは、borderStyleメソッドを設定します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.borderWidth(2);
comment.borderStyle("dotted");
comment.borderColor("red");
activeSheet.getCell(5,5).comment(comment);
activeSheet.suspendPaint();
activeSheet.resumePaint();
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
string |
コメントの境界線スタイル。 |
戻り値
any
値が設定されていない場合は、コメントの境界線スタイルを返します。値が設定されている場合は、コメントを返します。
borderWidth
▸ borderWidth(value?): any
コメントの境界線の幅を取得または設定します。
実例
// 次のサンプルコードは、borderWidthメソッドを設定します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.borderWidth(2);
comment.borderStyle("dotted");
comment.borderColor("red");
activeSheet.getCell(5,5).comment(comment);
activeSheet.suspendPaint();
activeSheet.resumePaint();
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
number |
コメントの境界線の幅。 |
戻り値
any
値が設定されていない場合は、コメントの境界線の幅を返します。値が設定されている場合は、コメントを返します。
commentState
▸ commentState(value?): any
コメントの状態を取得または設定します。
実例
// 次のサンプルコードは、コメントの状態を取得します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
activeSheet.getCell(5,5).comment(comment);
alert(comment.commentState());
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
CommentState |
コメントの状態。 |
戻り値
any
値が設定されていない場合は、コメントの状態を返します。値が設定されている場合は、コメントを返します。
displayMode
▸ displayMode(value?): any
コメントの表示モードを取得または設定します。
実例
// 次のサンプルコードは、displayModeメソッドを設定します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
DisplayMode |
コメントの表示モード。 |
戻り値
any
値が設定されていない場合は、コメントの表示モードを返します。値が設定されている場合は、コメントを返します。
dynamicMove
▸ dynamicMove(value?): any
コメントが動的に移動するかどうかを取得または設定します。
実例
// 次のサンプルコードは、dynamicMoveメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.dynamicMove(true);
comment.dynamicSize(true);
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
コメントが動的に移動するかどうか。 |
戻り値
any
値が設定されていない場合は、コメントが動的に移動するかどうかを返します。値が設定されている場合は、コメントを返します。
dynamicSize
▸ dynamicSize(value?): any
コメントが動的にサイズ設定されるかどうかを取得または設定します。
実例
// 次のサンプルコードは、dynamicSizeメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.dynamicMove(true);
comment.dynamicSize(true);
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
コメントが動的にサイズ設定されるかどうか。 |
戻り値
any
値が設定されていない場合は、コメントが動的にサイズ設定されるかどうかを返します。値が設定されている場合は、コメントを返します。
fontFamily
▸ fontFamily(value?): any
コメントのフォントファミリーを取得または設定します。
実例
// 次のサンプルコードは、fontFamilyメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.fontFamily("Comic Sans MS");
comment.fontSize("10pt");
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
string |
コメントのフォントファミリー。 |
戻り値
any
値が設定されていない場合は、コメントのフォントファミリーを返します。値が設定されている場合は、コメントを返します。
fontSize
▸ fontSize(value?): any
コメントのフォントサイズを取得または設定します。有効な値は、数字の後に"pt"（必須）を付けたものです（例："12pt"）。
実例
// 次のサンプルコードは、fontSizeメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.fontFamily("Comic Sans MS");
comment.fontSize("10pt");
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
string |
コメントのフォントサイズ。 |
戻り値
any
値が設定されていない場合は、コメントのフォントサイズを返します。値が設定されている場合は、コメントを返します。
fontStyle
▸ fontStyle(value?): any
コメントのフォントスタイルを取得または設定します。
実例
// 次のサンプルコードは、fontStyleメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.fontFamily("Comic Sans MS");
comment.fontStyle("normal");
comment.fontWeight("normal");
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
string |
コメントのフォントスタイル。 |
戻り値
any
値が設定されていない場合は、コメントのフォントスタイルを返します。値が設定されている場合は、コメントを返します。
fontWeight
▸ fontWeight(value?): any
コメントのフォントウェイトを取得または設定します。
実例
// 次のサンプルコードは、fontWeightメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.fontFamily("Comic Sans MS");
comment.fontStyle("normal");
comment.fontWeight("normal");
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
string |
コメントのフォントウェイト。 |
戻り値
any
値が設定されていない場合は、コメントのフォントウェイトを返します。値が設定されている場合は、コメントを返します。
foreColor
▸ foreColor(value?): any
コメントのテキストの色を取得または設定します。
実例
// 次のサンプルコードは、foreColorメソッドを設定します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
string |
コメントのテキストの色。 |
戻り値
any
値が設定されていない場合は、コメントのテキストの色を返します。値が設定されている場合は、コメントを返します。
height
▸ height(value?): any
コメントの高さを取得または設定します。
実例
// 次のサンプルコードは、heightメソッドを設定します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.height(50);
comment.width(90);
activeSheet.getCell(5,5).comment(comment);
activeSheet.suspendPaint();
activeSheet.resumePaint();
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
number |
コメントの高さ。 |
戻り値
any
値が設定されていない場合は、コメントの高さを返します。値が設定されている場合は、コメントを返します。
horizontalAlign
▸ horizontalAlign(value?): any
コメントの水平方向の配置を取得または設定します。
実例
// 次のサンプルコードは、horizontalAlignメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.horizontalAlign(GC.Spread.Sheets.HorizontalAlign.center);
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
HorizontalAlign |
コメントの水平方向の配置。 |
戻り値
any
値が設定されていない場合は、コメントの水平方向の配置を返します。値が設定されている場合は、コメントを返します。
indicatorColor
▸ indicatorColor(value?): any
コメントのindicatorColorを取得または設定します。
実例
// 次のサンプルコードは、indicatorColorメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
var color1 = "red";
var color2 = "#FFFFFF";
var color2 = "rgba(255, 255, 255, 0.01)";
comment.indicatorColor(color1);
activeSheet.comments.add(5, 5, comment);
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
string |
コメントのindicatorColor。 |
戻り値
any
値が設定されていない場合は、commentAdornerの色を返します。 それ以外の場合は、コメントを返します。
indicatorSize
▸ indicatorSize(value?): any
コメントのindicatorColorを取得または設定します。
実例
// 次のサンプルコードは、indicatorColorメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.indicatorSize(6);
activeSheet.comments.add(5, 5, comment);
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
number |
コメントのindicatorColor。 |
戻り値
any
値が設定されていない場合は、commentAdornerの色を返します。 それ以外の場合は、コメントを返します。
location
▸ location(value?): any
コメントの位置を取得または設定します。
実例
// 次のサンプルコードは、locationメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.location(new GC.Spread.Sheets.Point(10, 10));
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
Point |
コメントの位置。 |
戻り値
any
値が設定されていない場合は、コメントの位置を返します。値が設定されている場合は、コメントを返します。
lockText
▸ lockText(value?): any
コメントのロックテキストを取得または設定します。
実例
// 次のサンプルコードは、lockTextメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.lockText(false);
comment.locked(false);
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
activeSheet.options.isProtected = true;
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
コメントのロックテキスト。 |
戻り値
any
値が設定されていない場合は、コメントのロックテキストを返します。値が設定されている場合は、コメントを返します。
locked
▸ locked(value?): any
コメントのロック設定を取得または設定します。
実例
// 次のサンプルコードは、lockedメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.lockText(false);
comment.locked(false);
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
activeSheet.options.isProtected = true;
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
コメントのロック設定。 |
戻り値
any
値が設定されていない場合は、コメントのロック設定を返します。値が設定されている場合は、コメントを返します。
opacity
▸ opacity(value?): any
コメントの不透明度を取得または設定します。
実例
// 次のサンプルコードは、不透明度を設定します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.opacity(10);
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
number |
コメントの不透明度。 |
戻り値
any
値が設定されていない場合は、コメントの不透明度を返します。値が設定されている場合は、コメントを返します。
padding
▸ padding(value?): any
コメントのパディングを取得または設定します。
実例
// 次のサンプルコードは、paddingメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.padding(new GC.Spread.Sheets.Comments.Padding(2, 2, 2, 2));
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
Padding |
コメントのパディング。 |
戻り値
any
値が設定されていない場合は、コメントのパディングを返します。値が設定されている場合は、コメントを返します。
showShadow
▸ showShadow(value?): any
コメントに影を表示するかどうかを取得または設定します。
実例
// 次のサンプルコードは、showShadowメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.borderWidth(2);
comment.borderStyle("dotted");
comment.borderColor("red");
comment.showShadow(true);
activeSheet.getCell(5,5).comment(comment);
activeSheet.suspendPaint();
activeSheet.resumePaint();
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
コメントに影を表示するかどうか。 |
戻り値
any
値が設定されていない場合は、コメントに影を表示するかどうかを返します。値が設定されている場合は、コメントを返します。
text
▸ text(value?): any
コメントのテキストを取得または設定します。
実例
// 次のサンプルコードは、textメソッドを設定します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
activeSheet.getCell(5,5).comment(comment);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
string |
コメントのテキスト。 |
戻り値
any
値が設定されていない場合は、コメントのテキストを返します。値が設定されている場合は、コメントを返します。
textDecoration
▸ textDecoration(value?): any
コメントのテキスト装飾を取得または設定します。
実例
// 次のサンプルコードは、textDecorationメソッドを使用します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.textDecoration(GC.Spread.Sheets.TextDecorationType.underline);
activeSheet.getCell(5,5).comment(comment);
activeSheet.suspendPaint();
activeSheet.resumePaint();
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
TextDecorationType |
コメントのテキスト装飾。 |
戻り値
any
値が設定されていない場合は、コメントのテキスト装飾を返します。値が設定されている場合は、コメントを返します。
width
▸ width(value?): any
コメントの幅を取得または設定します。
実例
// 次のサンプルコードは、widthメソッドを設定します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
comment.height(50);
comment.width(90);
activeSheet.getCell(5,5).comment(comment);
activeSheet.suspendPaint();
activeSheet.resumePaint();
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
number |
コメントの幅。 |
戻り値
any
値が設定されていない場合は、コメントの幅を返します。値が設定されている場合は、コメントを返します。
zIndex
▸ zIndex(value?): any
コメントのzインデックスを取得または設定します。
実例
// 次のサンプルコードは、インデックスを取得します。
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
activeSheet.getCell(5,5).comment(comment);
alert(comment.zIndex());
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
number |
コメントのzインデックス。 |
戻り値
any
値が設定されていない場合は、コメントのzインデックスを返します。値が設定されている場合は、コメントを返します。