GC.Spread.Sheets.Shapes.FormControlShape

クラス: FormControlShape

Sheets.Shapes.FormControlShape

Hierarchy

Shape

↳ FormControlShape

コンストラクタ

constructor

メソッド

コンストラクタ

constructor

• new FormControlShape(worksheet, formControlType, left?, top?, width?, height?)

パラメータ

名前	型	説明
`worksheet`	`Worksheet`	シェイプのホストワークシート。
`formControlType`	`FormControlType`	-
`left?`	`number`	シェイプのx位置。
`top?`	`number`	シェイプのy位置。
`width?`	`number`	シェイプの幅。
`height?`	`number`	シェイプの高さ。

Overrides

Shape.constructor

メソッド

adjustments

▸ adjustments(arrayValue?): void | number[]

シェイプの調整値を取得または設定します。

実例

var blockArc = sheet.shapes.add("", GC.Spread.Sheets.Shapes.AutoShapeType.blockArc, 100, 60, 200, 160);
var adjustments = blockArc.adjustments();
console.log(adjustments);
adjustments[0] = 150;
adjustments[1] = 15;
adjustments[2] = 0.35;
blockArc.adjustments(adjustments);
blockArc.isSelected(true);

パラメータ

名前	型	説明
`arrayValue?`	`number`[]	配列に格納された調整値。

戻り値

void | number[]

値が設定されていない場合、シェイプの現在の調整値を返します。

Inherited from

Shape.adjustments

allowMove

▸ allowMove(value?): any

シェイプの移動を無効にするかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.allowMove();
heart.allowMove(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	シェイプの移動を無効にするかどうかの設定。

戻り値

any

値が設定されていない場合、シェイプの移動を無効にするかどうかの設定を返します。

Inherited from

Shape.allowMove

allowResize

▸ allowResize(value?): any

シェイプのサイズ変更モードを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.allowResize();
heart.allowResize(GC.Spread.Sheets.Shapes.ResizeMode.aspect);

パラメータ

名前	型	説明
`value?`	`boolean` \| `ResizeMode`	シェイプのサイズ変更を無効にするかどうかの設定。

戻り値

any

値が設定されていない場合、シェイプのサイズ変更を無効にするかどうかの設定を返します。

Inherited from

Shape.allowResize

allowRotate

▸ allowRotate(value?): any

シェイプの回転を無効にするかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.allowRotate();
heart.allowRotate(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	シェイプの回転を無効にするかどうかの設定。

戻り値

any

値が設定されていない場合、シェイプの回転を無効にするかどうかの設定を返します。

Inherited from

Shape.allowRotate

alt

▸ alt(value?): string | void

スクリーンリーダーのシェイプの代替テキストを取得または設定します。

パラメータ

名前	型	説明
`value?`	`string`	シェイプの代替テキスト。

戻り値

string | void

シェイプの代替テキスト。

Inherited from

Shape.alt

canPrint

▸ canPrint(value?): any

このシェイプが印刷可能かどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.canPrint();
heart.canPrint(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	このシェイプが印刷可能かどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプが印刷可能かどうかを返します。

Inherited from

Shape.canPrint

dynamicMove

▸ dynamicMove(value?): any

行または列を表示/非表示にするとき、サイズ変更するとき、または移動するときにシェイプが移動するかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.dynamicMove();
heart.dynamicMove(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	行または列を表示/非表示にするとき、サイズ変更するとき、または移動するときにシェイプが移動するかどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプが動的に移動するかどうかを返します。

Inherited from

Shape.dynamicMove

dynamicSize

▸ dynamicSize(value?): any

行または列を表示/非表示にするとき、サイズ変更するとき、または移動するときにシェイプのサイズが変更されるかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.dynamicSize();
heart.dynamicSize(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	行または列を表示/非表示にするとき、サイズ変更するとき、または移動するときにシェイプのサイズが変更されるかどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプのサイズが動的に変更されるかどうかを返します。

Inherited from

Shape.dynamicSize

enabled

▸ enabled(v?): boolean

有効なフォームコントロールシェイプを取得または設定します。

パラメータ

名前	型
`v?`	`boolean`

戻り値

boolean

endColumn

▸ endColumn(value?): any

シェイプの位置の終了列インデックスを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endColumn();
heart.endColumn(n + 1);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの位置の終了列インデックス。

戻り値

any

値が設定されていない場合、シェイプの位置の終了列インデックスを返します。

Inherited from

Shape.endColumn

endColumnOffset

▸ endColumnOffset(value?): any

シェイプの終了列に対するオフセットを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endColumnOffset();
heart.endColumnOffset(0);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの終了列に対するオフセット。

戻り値

any

値が設定されていない場合、シェイプの終了列に対するオフセットを返します。

Inherited from

Shape.endColumnOffset

endRow

▸ endRow(value?): any

シェイプの位置の終了行インデックスを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endRow();
heart.endRow(n + 2);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの位置の終了行インデックス。

戻り値

any

値が設定されていない場合、シェイプの位置の終了行インデックスを返します。

Inherited from

Shape.endRow

endRowOffset

▸ endRowOffset(value?): any

シェイプの終了行に対するオフセットを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endRowOffset();
heart.endRowOffset(0);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの終了行に対するオフセット。

戻り値

any

値が設定されていない場合、シェイプの終了行に対するオフセットを返します。

Inherited from

Shape.endRowOffset

formControlType

▸ formControlType(): FormControlType

FormControl固有の種類を取得します。

戻り値

FormControlType

getFormula

▸ getFormula(path): string

パスによってシェイプから数式の文字列を取得します。

実例

sheet.name("Sheet1");
sheet.setValue(0, 1, "This is a rectangle.");
var shape1 = sheet.shapes.add("myShape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 100, 100, 200, 200);
shape1.setFormula("text", "=Sheet1!B1");
shape1.getFormula("text");//returns "=Sheet1!B1"

パラメータ

名前	型	説明
`path`	`string`	数式の文字列を受け入れることができるパス。「x」、「y」、「width」、「height」、「rotate」、「text」、「style.fill.color」、「style.fill.transparency」、「style.fill.src」、「style.fill.tilePictureAsTexture」、「style.fill.offsetLeft」、「style.fill.offsetRight」、「style.fill.offsetTop」、「style.fill.offsetBottom」、「style.fill.offsetX」、「style.fill.offsetY」、「style.fill.scaleX」、「style.fill.scaleY」、「style.fill.alignment」、「style.fill.mirrorType」、「style.fill.type」、「style.fill.angle」、「style.fill.direction」、「style.fill.stops.0.color」、「style.fill.stops.0.position」、「style.fill.stops.0.transparency」、「style.fill.stops.0.brightness」、「style.line.color」、「style.line.lineStyle」、「style.line.width」、「style.line.capType」、「style.line.joinType」、「style.line.compoundType」、「style .line.transparency 」、「style.textEffect.color」、「style.textEffect.transparency」、「style.textEffect.font」、「style.textFrame.vAlign」、「style.textFrame.hAlign」のいずれかに設定できます。

戻り値

string

パスによってシェイプから数式の文字列を返します。

Inherited from

Shape.getFormula

height

▸ height(value?): any

シェイプの高さを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.height();
heart.height(n + 50);

パラメータ

名前	型	説明
`value?`	`string` \| `number`	数値によって指定されたシェイプの高さ、または数値を取得できる数式（=で始まる）。

戻り値

any

値が設定されていない場合、シェイプの高さを返します。

Inherited from

Shape.height

hyperlink

▸ hyperlink(value?): void | IHyperlink

シェイプのハイパーリンクを取得または設定します。

実例

var shape = sheet.shapes.add("myShape", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 62 * 9, 0, 200, 200);
shape.hyperlink({url: "http://www.grapecity.com", target: 0, tooltip: 'goes to grapecity'});

パラメータ

名前	型
`value?`	`IHyperlink`

戻り値

void | IHyperlink

値が設定されていない場合は、シェイプの現在のハイパーリンク設定を返します。

Inherited from

Shape.hyperlink

isLocked

▸ isLocked(value?): any

このシェイプがロックされているかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.isLocked();
heart.isLocked(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	このシェイプがロックされているかどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプがロックされているかどうかを返します。

Inherited from

Shape.isLocked

isSelected

▸ isSelected(value?): any

このシェイプが選択されているかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.isSelected();
heart.isSelected(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	このシェイプが選択されているかどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプが選択されているかどうかを返します。

Inherited from

Shape.isSelected

isTextBox

▸ isTextBox(value?): boolean | void

テキストボックスシェイプを取得または設定します。

実例

var rectangle = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 100, 60, 200, 160);
rectangle.isTextBox(true);

パラメータ

名前	型
`value?`	`boolean`

戻り値

boolean | void

値が設定されていない場合は、シェイプがテキストボックスであるかどうかを返します。

Inherited from

Shape.isTextBox

isVisible

▸ isVisible(value?): any

このシェイプが表示されるかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.isVisible();
heart.isVisible(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	このシェイプが表示されるかどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプが表示されるかどうかを返します。

Inherited from

Shape.isVisible

name

▸ name(value?): any

シェイプの名前を取得または設定します。

実例

var shape1 = sheet.shapes.add("myShape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 62 * 9, 0, 200, 200);
var shape2 = sheet.shapes.add("myShape2", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 20, 20, 200, 200);
var shape = sheet.shapes.group([shape1, shape2]);
shape.name("myGroupShape");
var shapeName = shape.name();

パラメータ

名前	型	説明
`value?`	`string`	シェイプの名前。

戻り値

any

値が設定されていない場合、シェイプの名前を返します。

Inherited from

Shape.name

options

▸ options(v?): IFormControlShapeOptions

フォームコントロールシェイプのオプションを取得または設定します。

パラメータ

名前	型
`v?`	`IFormControlShapeOptions`

戻り値

IFormControlShapeOptions

rotate

▸ rotate(value?): number | void

シェイプの回転角度（度単位）を取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.rotate();
heart.rotate(n + 30);

パラメータ

名前	型	説明
`value?`	`string` \| `number`	数値によって指定されたシェイプの回転角度（度単位）、または数値を取得できる数式（=で始まる）。

戻り値

number | void

値が設定されていない場合、シェイプの回転角度（度単位）を返します。

Inherited from

Shape.rotate

setFormula

▸ setFormula(path, formula): void

パスによってシェイプに数式の文字列を設定します。

実例

sheet.name("Sheet1");
sheet.setValue(0, 1, "This is a rectangle.");
var shape1 = sheet.shapes.add("myShape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 100, 100, 200, 200);
shape1.setFormula("text", "=Sheet1!B1");

パラメータ

名前	型	説明
`path`	`string`	数式の文字列を受け入れることができるパス。「x」、「y」、「width」、「height」、「rotate」、「text」、「style.fill.color」、「style.fill.transparency」、「style.fill.src」、「style.fill.tilePictureAsTexture」、「style.fill.offsetLeft」、「style.fill.offsetRight」、「style.fill.offsetTop」、「style.fill.offsetBottom」、「style.fill.offsetX」、「style.fill.offsetY」、「style.fill.scaleX」、「style.fill.scaleY」、「style.fill.alignment」、「style.fill.mirrorType」、「style.fill.type」、「style.fill.angle」、「style.fill.direction」、「style.fill.stops.0.color」、「style.fill.stops.0.position」、「style.fill.stops.0.transparency」、「style.fill.stops.0.brightness」、「style.line.color」、「style.line.lineStyle」、「style.line.width」、「style.line.capType」、「style.line.joinType」、「style.line.compoundType」、「style .line.transparency 」、「style.textEffect.color」、「style.textEffect.transparency」、「style.textEffect.font」、「style.textFrame.vAlign」、「style.textFrame.hAlign」のいずれかに設定できます。
`formula`	`string`	数式文字列。

戻り値

void

Inherited from

Shape.setFormula

showHandle

▸ showHandle(value?): boolean | void

シェイプのハンドルを表示するかどうかを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.showHandle();
heart.showHandle(!state);

パラメータ

名前	型	説明
`value?`	`boolean`	シェイプのハンドルを表示するかどうかの設定。

戻り値

boolean | void

値が設定されていない場合、シェイプのハンドルを表示するかどうかの設定を返します。

Inherited from

Shape.showHandle

startColumn

▸ startColumn(value?): any

シェイプの位置の開始列インデックスを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startColumn();
heart.startColumn(n + 2);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの位置の開始列インデックス。

戻り値

any

値が設定されていない場合、シェイプの位置の開始列インデックスを返します。

Inherited from

Shape.startColumn

startColumnOffset

▸ startColumnOffset(value?): any

シェイプの開始列に対するオフセットを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startColumnOffset();
heart.startColumnOffset(0);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの開始列に対するオフセット。

戻り値

any

値が設定されていない場合、シェイプの開始列に対するオフセットを返します。

Inherited from

Shape.startColumnOffset

startRow

▸ startRow(value?): any

シェイプの位置の開始行インデックスを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startRow();
heart.startRow(n + 2);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの位置の開始行インデックス。

戻り値

any

値が設定されていない場合、シェイプの位置の開始行インデックスを返します。

Inherited from

Shape.startRow

startRowOffset

▸ startRowOffset(value?): any

シェイプの開始行に対するオフセットを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startRowOffset();
heart.startRowOffset(0);

パラメータ

名前	型	説明
`value?`	`number`	シェイプの開始行に対するオフセット。

戻り値

any

値が設定されていない場合、シェイプの開始行に対するオフセットを返します。

Inherited from

Shape.startRowOffset

style

▸ style(value?): any

シェイプのスタイルを取得または設定します。

実例

// 次のサンプルコードは、シェイプのスタイルを設定します。
var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var oldStyle = heart.style();
oldStyle.fill.color = "red";
oldStyle.fill.transparency = 0.5;
oldStyle.line.color = "green";
oldStyle.line.lineStyle = GC.Spread.Sheets.Shapes.PresetLineDashStyle.dashDot;
oldStyle.line.width = 5;
oldStyle.line.capType = GC.Spread.Sheets.Shapes.LineCapStyle.square;
oldStyle.line.joinType = GC.Spread.Sheets.Shapes.LineJoinStyle.miter;
oldStyle.line.compoundType = GC.Spread.Sheets.Shapes.CompoundType.double;
oldStyle.line.transparency = 0.5;
oldStyle.textEffect.color = "yellow";
oldStyle.textEffect.transparency = 0.5;
oldStyle.textEffect.font = "20px Arial";
oldStyle.textFrame.vAlign = GC.Spread.Sheets.VerticalAlign.center;
oldStyle.textFrame.hAlign = GC.Spread.Sheets.HorizontalAlign.center;
heart.style(oldStyle);
heart.text("Heart");

パラメータ

名前	型	説明
`value?`	`ShapeStyle`	シェイプのスタイル。

戻り値

any

値が設定されていない場合、シェイプの現在のスタイルを返します。

Inherited from

Shape.style

text

▸ text(value?): any

シェイプのテキストを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
heart.text("My Shape");
var s = heart.text();

パラメータ

名前	型	説明
`value?`	`string`	文字列によって指定されたシェイプのテキスト、または文字列を取得できる数式（=で始まる）。

戻り値

any

値が設定されていない場合、シェイプのテキストを返します。

Inherited from

Shape.text

type

▸ type(value?): any

シェイプのタイプを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.type();
heart.type(GC.Spread.Sheets.Shapes.AutoShapeType.cloud);

パラメータ

名前	型	説明
`value?`	`AutoShapeType`	シェイプのタイプ。

戻り値

any

値が設定されていない場合、シェイプのタイプを返します。

Inherited from

Shape.type

value

▸ value(v?): IFormControlShapeValue

フォームコントロールシェイプの値を取得または設定します。

パラメータ

名前	型
`v?`	`IFormControlShapeValue`

戻り値

IFormControlShapeValue

width

▸ width(value?): any

シェイプの幅を取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.width();
heart.width(n + 50);

パラメータ

名前	型	説明
`value?`	`string` \| `number`	数値によって指定されたシェイプの幅、または数値を取得できる数式（=で始まる）。

戻り値

any

値が設定されていない場合、シェイプの幅を返します。

Inherited from

Shape.width

x

▸ x(value?): number | void

シェイプの水平位置を取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.x();
heart.x(n + 50);

パラメータ

名前	型	説明
`value?`	`string` \| `number`	数値によって指定されたシェイプの水平位置、または数値を取得できる数式（=で始まる）。

戻り値

number | void

値が設定されていない場合、シェイプの水平位置を返します。

Inherited from

Shape.x

y

▸ y(value?): any

シェイプの垂直位置を取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.y();
heart.y(n + 50);

パラメータ

名前	型	説明
`value?`	`string` \| `number`	数値によって指定されたシェイプの垂直位置、または数値を取得できる数式（=で始まる）。

戻り値

any

値が設定されていない場合、シェイプの垂直位置を返します。

Inherited from

Shape.y

GC.Spread.Sheets.Shapes.FormControlShape

クラス: FormControlShape

Hierarchy

Table of contents

コンストラクタ

メソッド

コンストラクタ

constructor

パラメータ

Overrides

メソッド

adjustments

パラメータ

戻り値

Inherited from

allowMove

パラメータ

戻り値

Inherited from

allowResize

パラメータ

戻り値

Inherited from

allowRotate

パラメータ

戻り値

Inherited from

alt

パラメータ

戻り値

Inherited from

canPrint

パラメータ

戻り値

Inherited from

dynamicMove

パラメータ

戻り値

Inherited from

dynamicSize

パラメータ

戻り値

Inherited from

enabled

パラメータ

戻り値

endColumn

パラメータ

戻り値

Inherited from

endColumnOffset

パラメータ

戻り値

Inherited from

endRow

パラメータ

戻り値

Inherited from

endRowOffset

パラメータ

戻り値

Inherited from

formControlType

戻り値

getFormula

パラメータ

戻り値

Inherited from

height

パラメータ

戻り値

Inherited from

hyperlink

パラメータ

戻り値

Inherited from

isLocked

パラメータ

戻り値

Inherited from