GC.Spread.Sheets.CellTypes.Button

クラス: Button

Sheets.CellTypes.Button

Hierarchy

Base

↳ Button

コンストラクタ

constructor

プロパティ

typeName

メソッド

コンストラクタ

constructor

• new Button()

ボタン型のセルを表します。

実例

// 次のサンプルコードは、ボタン型セルを作成します。
var spread = new GC.Spread.Sheets.Workbook();
var sheet = spread.getActiveSheet();
var cellType = new GC.Spread.Sheets.CellTypes.Button();
cellType.buttonBackColor("#FFFF00");
cellType.text("this is a button");
sheet.setCellType(1,1,cellType);
// イベントをバインドします。
spread.bind(GC.Spread.Sheets.Events.ButtonClicked, function (e, args) {
    var sheet = args.sheet, row = args.row, col = args.col;
    var cellType = sheet.getCellType(row, col);
    if (cellType instanceof GC.Spread.Sheets.CellTypes.Button) {
        alert("Button Clicked");
    }
});

オーバーライド

Base.constructor

プロパティ

typeName

• typeName: string

シリアル化のサポートに使用される型名の文字列を表します。

継承元

Base.typeName

メソッド

activateEditor

▸ activateEditor(editorContext, cellStyle, cellRect, context?): void

エディタをアクティブにし、エディタのプロパティまたは属性の設定やイベントの連結などを行います。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`cellStyle`	`Style`	セルの実際のスタイル。
`cellRect`	`Rect`	セルのレイアウト情報。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

継承元

Base.activateEditor

buttonBackColor

▸ buttonBackColor(value?): any

ボタンの背景色を取得または設定します。

実例

// 次のサンプルコードは、ボタン型セルを作成します。
var cellType = new GC.Spread.Sheets.CellTypes.Button();
cellType.buttonBackColor("#FFFF00");
cellType.text("this is a button");
activeSheet.getCell(0, 2).cellType(cellType);

パラメータ

名前	型	説明
`value?`	`string`	ボタンの背景色。

戻り値

any

値が設定されていない場合は、背景色を返します。値が設定されている場合は、コマンドボタンセル型を返します。

createEditorElement

▸ createEditorElement(context?): HTMLElement

DOM要素を作成して返します。

パラメータ

名前	型	説明
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

HTMLElement

DOM要素を返します。

継承元

Base.createEditorElement

deactivateEditor

▸ deactivateEditor(editorContext, context?): void

エディタを非アクティブにします。エディタのイベントの連結解除などが行われます。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

継承元

Base.deactivateEditor

focus

▸ focus(editorContext, context?): void

エディタDOM要素にフォーカスを設定します。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

継承元

Base.focus

format

▸ format(value, format, formattedData?, context?): string

指定した書式を使用して値を文字列に書式設定します。

パラメータ

名前	型	説明
`value`	`any`	書式設定するオブジェクト値。
`format`	`string` \| `GeneralFormatter`	書式。
`formattedData?`	`FormattedData`	書式付きデータ。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

string

書式設定された文字列を返します。

継承元

Base.format

fromJSON

▸ fromJSON(settings): void

指定したJSON文字列からオブジェクト状態をロードします。

パラメータ

名前	型	説明
`settings`	`any`	逆シリアル化されたセル型のデータ。

戻り値

void

継承元

Base.fromJSON

getAutoFitHeight

▸ getAutoFitHeight(value, text, cellStyle, zoomFactor, context?): number

行の自動サイズ調整の処理に使用できるセルの高さを取得します。

パラメータ

名前	型	説明
`value`	`any`	セルの値。
`text`	`string`	セルのテキスト。
`cellStyle`	`Style`	セルの実際の値。
`zoomFactor`	`number`	現在のシートのズーム率。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

number

行の自動サイズ調整の処理に使用できるセルの高さを返します。

継承元

Base.getAutoFitHeight

getAutoFitWidth

▸ getAutoFitWidth(value, text, cellStyle, zoomFactor, context?): number

列の自動サイズ調整の処理に使用できるセルの幅を取得します。

パラメータ

名前	型	説明
`value`	`any`	セルの値。
`text`	`string`	セルのテキスト。
`cellStyle`	`Style`	セルの実際の値。
`zoomFactor`	`number`	現在のシートのズーム率。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

number

列の自動サイズ調整の処理に使用できるセルの幅を返します。

継承元

Base.getAutoFitWidth

getEditorValue

▸ getEditorValue(editorContext, context?): any

エディタの値を取得します。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

any

エディタの値を返します。

継承元

Base.getEditorValue

getHitInfo

▸ getHitInfo(x, y, cellStyle, cellRect, context?): IHitTestCellTypeHitInfo

セル型のヒット情報を取得します。

パラメータ

名前	型	説明
`x`	`number`	キャンバスを基準とする現在のポインタ位置の<i>x</i>座標。
`y`	`number`	キャンバスを基準とする現在のポインタ位置の<i>y</i>座標。
`cellStyle`	`Style`	現在のセルの実際のスタイル。
`cellRect`	`Rect`	現在のセルのレイアウト情報。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

IHitTestCellTypeHitInfo

x、y、row、col、cellRect、sheetAreaの各パラメーターと、isReservedLocationを示す値を含むオブジェクトを返します。isReservedLocationは、ヒットテストが、セル型が処理しなければならない特別な領域に位置する場合はtrue、それ以外の場合はfalseになります。

継承元

Base.getHitInfo

isEditingValueChanged

▸ isEditingValueChanged(oldValue, newValue, context?): boolean

編集値が変更されたかどうか。

パラメータ

名前	型	説明
`oldValue`	`any`	古い編集値。
`newValue`	`any`	新しい編集値。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

boolean

oldValueがnewValueと等しい場合は<c>true</c>、それ以外の場合は<c>false</c>。

継承元

Base.isEditingValueChanged

isImeAware

▸ isImeAware(context?): boolean

このセル型がIMEを認識するかどうか。

パラメータ

名前	型	説明
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

boolean

セル型がIMEを認識する場合は<c>true</c>、それ以外の場合は<c>false</c>。

継承元

Base.isImeAware

isReservedKey

▸ isReservedKey(e, context?): boolean

セル型がキーボードイベントを自分で処理するかどうかを返します。

パラメータ

名前	型	説明
`e`	`KeyboardEvent`	KeyboardEvent。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

boolean

セル型がキーボードイベントを自分で処理する場合は<c>true</c>、それ以外の場合は<c>false</c>を返します。

継承元

Base.isReservedKey

marginBottom

▸ marginBottom(value?): any

セルに対するボタンの下マージン（ピクセル単位）を取得または設定します。

実例

//次のサンプルコードは、ボタン型セルを作成してその余白を設定します。
var cellType = new GC.Spread.Sheets.CellTypes.Button();
cellType.buttonBackColor("#FFFF00");
cellType.text("this is a button");
cellType.marginTop(5).marginRight(8).marginBottom(10).marginLeft(12);
activeSheet.getCell(0, 2).cellType(cellType);
activeSheet.setColumnWidth(2, 120.0,GC.Spread.Sheets.SheetArea.viewport);
activeSheet.setRowHeight(0, 90.0,GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
`value?`	`number`	セルに対するボタンの下マージン。

戻り値

any

値が設定されていない場合は、下マージン（ピクセル単位）を返します。値が設定されている場合は、コマンドボタンセル型を返します。

marginLeft

▸ marginLeft(value?): any

セルに対するボタンの左マージン（ピクセル単位）を取得または設定します。

実例

//次のサンプルコードは、ボタン型セルを作成してその余白を設定します。
var cellType = new GC.Spread.Sheets.CellTypes.Button();
cellType.buttonBackColor("#FFFF00");
cellType.text("this is a button");
cellType.marginTop(5).marginRight(8).marginBottom(10).marginLeft(12);
activeSheet.getCell(0, 2).cellType(cellType);
activeSheet.setColumnWidth(2, 120.0,GC.Spread.Sheets.SheetArea.viewport);
activeSheet.setRowHeight(0, 90.0,GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
`value?`	`number`	セルに対するボタンの左マージン。

戻り値

any

値が設定されていない場合は、左マージン（ピクセル単位）を返します。値が設定されている場合は、コマンドボタンセル型を返します。

marginRight

▸ marginRight(value?): any

セルに対するボタンの右マージン（ピクセル単位）を取得または設定します。

実例

//次のサンプルコードは、ボタン型セルを作成してその余白を設定します。
var cellType = new GC.Spread.Sheets.CellTypes.Button();
cellType.buttonBackColor("#FFFF00");
cellType.text("this is a button");
cellType.marginTop(5).marginRight(8).marginBottom(10).marginLeft(12);
activeSheet.getCell(0, 2).cellType(cellType);
activeSheet.setColumnWidth(2, 120.0,GC.Spread.Sheets.SheetArea.viewport);
activeSheet.setRowHeight(0, 90.0,GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
`value?`	`number`	セルに対するボタンの右マージン。

戻り値

any

値が設定されていない場合は、右マージン（ピクセル単位）を返します。値が設定されている場合は、コマンドボタンセル型を返します。

marginTop

▸ marginTop(value?): any

セルに対するボタンの上マージン（ピクセル単位）を取得または設定します。

実例

//次のサンプルコードは、ボタン型セルを作成してその余白を設定します。
var cellType = new GC.Spread.Sheets.CellTypes.Button();
cellType.buttonBackColor("#FFFF00");
cellType.text("this is a button");
cellType.marginTop(5).marginRight(8).marginBottom(10).marginLeft(12);
activeSheet.getCell(0, 2).cellType(cellType);
activeSheet.setColumnWidth(2, 120.0,GC.Spread.Sheets.SheetArea.viewport);
activeSheet.setRowHeight(0, 90.0,GC.Spread.Sheets.SheetArea.viewport);

パラメータ

名前	型	説明
`value?`	`number`	セルに対するボタンの上マージン。

戻り値

any

値が設定されていない場合は、上マージン（ピクセル単位）を返します。値が設定されている場合は、コマンドボタンセル型を返します。

paint

▸ paint(ctx, value, x, y, w, h, style, context?): void

キャンバスにセルを描画します。

パラメータ

名前	型	説明
`ctx`	`CanvasRenderingContext2D`	キャンバスの2次元コンテキスト。
`value`	`any`	セルの値。
`x`	`number`	キャンバスを基準とする<i>x</i>座標。
`y`	`number`	キャンバスを基準とする<i>y</i>座標。
`w`	`number`	セルの幅。
`h`	`number`	セルの高さ。
`style`	`Style`	セルの実際のスタイル。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

継承元

Base.paint

paintContent

▸ paintContent(ctx, value, x, y, w, h, style, context?): void

キャンバスにセル内容領域を描画します。

パラメータ

名前	型	説明
`ctx`	`CanvasRenderingContext2D`	キャンバスの2次元コンテキスト。
`value`	`any`	セルの値。
`x`	`number`	キャンバスを基準とする<i>x</i>座標。
`y`	`number`	キャンバスを基準とする<i>y</i>座標。
`w`	`number`	セル内容領域の幅。
`h`	`number`	セル内容領域の高さ。
`style`	`Style`	セルの実際のスタイル。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

継承元

Base.paintContent

parse

▸ parse(text, formatStr, context?): any

指定した書式文字列を使用してテキストをオブジェクトに解析します。

パラメータ

名前	型	説明
`text`	`string`	解析するテキスト文字列。
`formatStr`	`string`	解析書式文字列。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

any

解析されたオブジェクト。

継承元

Base.parse

processKeyDown

▸ processKeyDown(event, context?): boolean

表示モードでキーダウンを処理します。

パラメータ

名前	型	説明
`event`	`KeyboardEvent`	KeyboardEvent。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

boolean

処理が成功した場合は<c>true</c>、それ以外の場合は<c>false</c>を返します。

継承元

Base.processKeyDown

processKeyUp

▸ processKeyUp(event, context?): boolean

表示モードでキーアップを処理します。

パラメータ

名前	型	説明
`event`	`KeyboardEvent`	KeyboardEvent。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

boolean

処理が成功した場合は<c>true</c>、それ以外の場合は<c>false</c>を返します。

継承元

Base.processKeyUp

processMouseDown

▸ processMouseDown(hitInfo): boolean

表示モードでマウスダウンを処理します。

パラメータ

名前	型	説明
`hitInfo`	`IHitTestCellTypeHitInfo`	getHitInfoメソッドによって返されたヒットテスト情報。詳細については、「解説」を参照してください。

戻り値

boolean

処理が成功した場合は<c>true</c>、それ以外の場合は<c>false</c>を返します。

継承元

Base.processMouseDown

processMouseEnter

▸ processMouseEnter(hitInfo): boolean

表示モードでマウスエンターを処理します。

パラメータ

名前	型	説明
`hitInfo`	`IHitTestCellTypeHitInfo`	getHitInfoメソッドによって返されたヒットテスト情報。詳細については、「解説」を参照してください。

戻り値

boolean

処理が成功した場合は<c>true</c>、それ以外の場合は<c>false</c>を返します。

継承元

Base.processMouseEnter

processMouseLeave

▸ processMouseLeave(hitInfo): boolean

表示モードでマウスリーブを処理します。

パラメータ

名前	型	説明
`hitInfo`	`IHitTestCellTypeHitInfo`	getHitInfoメソッドによって返されたヒットテスト情報。詳細については、「解説」を参照してください。

戻り値

boolean

処理が成功した場合は<c>true</c>、それ以外の場合は<c>false</c>を返します。

継承元

Base.processMouseLeave

processMouseMove

▸ processMouseMove(hitInfo): boolean

表示モードでマウスムーブを処理します。

パラメータ

名前	型	説明
`hitInfo`	`IHitTestCellTypeHitInfo`	getHitInfoメソッドによって返されたヒットテスト情報。詳細については、「解説」を参照してください。

戻り値

boolean

処理が成功した場合は<c>true</c>、それ以外の場合は<c>false</c>を返します。

継承元

Base.processMouseMove

processMouseUp

▸ processMouseUp(hitInfo): boolean

表示モードでマウスアップを処理します。

パラメータ

名前	型	説明
`hitInfo`	`IHitTestCellTypeHitInfo`	getHitInfoメソッドによって返されたヒットテスト情報。詳細については、「解説」を参照してください。

戻り値

boolean

処理が成功した場合は<c>true</c>、それ以外の場合は<c>false</c>を返します。

継承元

Base.processMouseUp

selectAll

▸ selectAll(editorContext, context?): void

エディタDOM要素内のすべてのテキストを選択します。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

継承元

Base.selectAll

setEditorValue

▸ setEditorValue(editorContext, value, context?): void

エディタの値を設定します。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`value`	`any`	アクティブセルから返された値。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

継承元

Base.setEditorValue

text

▸ text(value?): any

ボタンの内容を取得または設定します。

実例

// 次のサンプルコードは、ボタン型セルを作成します。
var cellType = new GC.Spread.Sheets.CellTypes.Button();
cellType.buttonBackColor("#FFFF00");
cellType.text("this is a button");
activeSheet.getCell(0, 2).cellType(cellType);

パラメータ

名前	型	説明
`value?`	`string`	ボタンの内容。

戻り値

any

値が設定されていない場合は、内容を返します。値が設定されている場合は、コマンドボタンセル型を返します。

toJSON

▸ toJSON(): any

オブジェクト状態をJSON文字列に保存します。

戻り値

any

セル型データ。

継承元

Base.toJSON

updateEditor

▸ updateEditor(editorContext, cellStyle, cellRect, context?): Rect

エディタのサイズを更新します。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`cellStyle`	`Style`	セルの実際のスタイル。
`cellRect`	`Rect`	セルのレイアウト情報。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

Rect

セルラッパー要素の新しいサイズを返します。これには'width'と'height'の2つのプロパティが含まれます。

継承元

Base.updateEditor

updateEditorContainer

▸ updateEditorContainer(editorContext, editorBounds, cellStyle): void

セルラッパー要素のサイズを更新します。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`editorBounds`	`Rect`	セルラッパー要素の新しいサイズ。
`cellStyle`	`Style`	セルの実際のスタイル。

戻り値

void

継承元

Base.updateEditorContainer

updateImeMode

▸ updateImeMode(editorContext, imeMode, context?): void

エディタのIMEモードを更新します。

パラメータ

名前	型	説明
`editorContext`	`HTMLElement`	createEditorElementメソッドによって作成されたDOM要素。
`imeMode`	`ImeMode`	セルの実際のスタイルからのIMEモード。
`context?`	`any`	セル型に関連付けられたコンテキスト。詳細については、「解説」を参照してください。

戻り値

void

継承元

Base.updateImeMode

GC.Spread.Sheets.CellTypes.Button

クラス: Button

Hierarchy

Table of contents

コンストラクタ

プロパティ

メソッド

コンストラクタ

constructor

オーバーライド

プロパティ

typeName

継承元

メソッド

activateEditor

パラメータ

戻り値

継承元

buttonBackColor

パラメータ

戻り値

createEditorElement

パラメータ

戻り値

継承元

deactivateEditor

パラメータ

戻り値

継承元

focus

パラメータ

戻り値

継承元

format

パラメータ

戻り値

継承元

fromJSON

パラメータ

戻り値

継承元

getAutoFitHeight

パラメータ

戻り値

継承元

getAutoFitWidth

パラメータ

戻り値

継承元

getEditorValue

パラメータ

戻り値

継承元

getHitInfo

パラメータ

戻り値

継承元

isEditingValueChanged

パラメータ

戻り値

継承元

isImeAware

パラメータ

戻り値

継承元

isReservedKey

パラメータ

戻り値

継承元

marginBottom

パラメータ

戻り値

marginLeft

パラメータ

戻り値

marginRight

パラメータ

戻り値

marginTop

パラメータ