- 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.CellRange
クラス: CellRange
Table of contents
コンストラクタ
プロパティ
メソッド
- altText
- backColor
- backgroundImage
- backgroundImageLayout
- bindingPath
- borderBottom
- borderLeft
- borderRight
- borderTop
- cellButtons
- cellPadding
- cellType
- clear
- comment
- defaultValue
- diagonalDown
- diagonalUp
- dropDowns
- font
- fontFamily
- fontSize
- fontStyle
- fontWeight
- foreColor
- formatter
- formula
- hAlign
- height
- hidden
- imeMode
- isVerticalText
- labelOptions
- locked
- mask
- quotePrefix
- resizable
- setBorder
- setStyle
- setStyleName
- showEllipsis
- shrinkToFit
- tabStop
- tag
- text
- textDecoration
- textDirection
- textIndent
- textOrientation
- themeFont
- toHtml
- vAlign
- validator
- value
- visible
- watermark
- width
- wordWrap
コンストラクタ
constructor
• new CellRange(sheet, row, col, rowCount?, colCount?, sheetArea?)
シートのセル範囲を表します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
sheet |
Worksheet |
このセル範囲を含むシート。 |
row |
number |
セルの行インデックス。 |
col |
number |
セルの列インデックス。 |
rowCount? |
number |
- |
colCount? |
number |
- |
sheetArea? |
SheetArea |
- |
プロパティ
col
• col: number
開始列インデックスを取得します。
colCount
• colCount: number
列数を取得します。
row
• row: number
開始行インデックスを取得します。
rowCount
• rowCount: number
行数を取得します。
sheet
• sheet: Worksheet
このセル範囲を含むシートを取得します。
sheetArea
• sheetArea: SheetArea
このセル範囲を含む領域を取得します。
メソッド
altText
▸ altText(value?): any
スクリーンリーダーのセルの代替テキストを取得または設定します。
実例
var SpreadIcon = {
FolderOpen: '\ue685',
InfoFilled: '\ue718',
Library: '\ue69d',
NotebookFilled: '\uD800\uDC0F',
Browse: '\ue626'
};
activeSheet.getCell(1, 1).value(SpreadIcon.FolderOpen).altText("Folder Open Icon");
// 代替テキストには、プレーンテキストに加えて、セルまたは書式設定されたセルの値を表すプレースホルダー {value} または {formatted} を含めることもできます。
// 例えば、セルの値が 1000 で、代替テキストが「Sales amount is {value}」である場合、最終的なコンテンツは「Sales amount is 1000」となります。
activeSheet.getCell(1, 1).value(1000).altText("Sales amount is {value}");
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
any |
セルの代替テキスト。 |
戻り値
any
値が設定されていない場合は、セルの代替テキストを返します。値が設定されている場合は、セルを返します。
backColor
▸ backColor(value?): any
セルの背景色（"red"、"#FFFF00"、"rgb(255,0,0)"、"Accent 5"など）を取得または設定します。
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).backColor("pink");
パラメータ
| 名前 | 型 |
|---|---|
value? |
string | IGradientFill | IGradientPathFill | IPatternFill |
戻り値
any
値が設定されていない場合は、セルの背景色を返します。値が設定されている場合は、セルを返します。
backgroundImage
▸ backgroundImage(value?): any
セルの背景画像を取得または設定します。
実例
activeSheet.getCell(1,1).backgroundImage("images/example.jpg");
パラメータ
| 名前 | 型 |
|---|---|
value? |
string |
戻り値
any
値が設定されていない場合は、セルの背景画像を返します。値が設定されている場合は、セルを返します。
backgroundImageLayout
▸ backgroundImageLayout(value?): any
セルの背景画像レイアウトを取得または設定します。
実例
var layout = GC.Spread.Sheets.ImageLayout.stretch;
activeSheet.getRange(-1, 1, -1, 1, GC.Spread.Sheets.SheetArea.viewport).backgroundImageLayout(layout);
パラメータ
| 名前 | 型 |
|---|---|
value? |
ImageLayout |
戻り値
any
値が設定されていない場合は、セルの背景画像レイアウトを返します。値が設定されている場合は、セルを返します。
bindingPath
▸ bindingPath(path?): any
セル連結の連結パスを取得または設定します。
実例
// 次のサンプルコードは、bindingPathメソッドを使用します。
var test = {name: "John"};
activeSheet.getCell(0,0).bindingPath( "name");
activeSheet.setDataSource(new GC.Spread.Sheets.Bindings.CellBindingSource(test));
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
path? |
string |
セル連結の連結パス。 |
戻り値
any
値が設定されていない場合は、セル連結の連結パスを返します。値が設定されている場合は、ワークシートを返します。
borderBottom
▸ borderBottom(value?): any
セルの下罫線を取得または設定します。
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderBottom(new GC.Spread.Sheets.LineBorder("blue", GC.Spread.Sheets.LineStyle.mediumDashed));
パラメータ
| 名前 | 型 |
|---|---|
value? |
LineBorder |
戻り値
any
値が設定されていない場合は、セルの下罫線を返します。値が設定されている場合は、セルを返します。
borderLeft
▸ borderLeft(value?): any
セルの左罫線を取得または設定します。
実例
activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).borderLeft(new GC.Spread.Sheets.LineBorder("green", GC.Spread.Sheets.LineStyle.mediumDashed));
実例
activeSheet.getCell(1,1).borderLeft(new GC.Spread.Sheets.LineBorder("red", GC.Spread.Sheets.LineStyle.double));
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderLeft(new GC.Spread.Sheets.LineBorder("blue", GC.Spread.Sheets.LineStyle.mediumDashed));
パラメータ
| 名前 | 型 |
|---|---|
value? |
LineBorder |
戻り値
any
値が設定されていない場合は、セルの左罫線を返します。値が設定されている場合は、セルを返します。
borderRight
▸ borderRight(value?): any
セルの右罫線を取得または設定します。
実例
activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).borderRight(new GC.Spread.Sheets.LineBorder("green", GC.Spread.Sheets.LineStyle.mediumDashed));
実例
activeSheet.getCell(1,1).borderRight(new GC.Spread.Sheets.LineBorder("red", GC.Spread.Sheets.LineStyle.double));
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderRight(new GC.Spread.Sheets.LineBorder("blue", GC.Spread.Sheets.LineStyle.mediumDashed));
パラメータ
| 名前 | 型 |
|---|---|
value? |
LineBorder |
戻り値
any
値が設定されていない場合は、セルの右罫線を返します。値が設定されている場合は、セルを返します。
borderTop
▸ borderTop(value?): any
セルの上罫線を取得または設定します。
実例
activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).borderTop(new GC.Spread.Sheets.LineBorder("green", GC.Spread.Sheets.LineStyle.mediumDashed));
実例
activeSheet.getCell(1,1).borderTop(new GC.Spread.Sheets.LineBorder("red", GC.Spread.Sheets.LineStyle.double));
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderTop(new GC.Spread.Sheets.LineBorder("blue", GC.Spread.Sheets.LineStyle.mediumDashed));
パラメータ
| 名前 | 型 |
|---|---|
value? |
LineBorder |
戻り値
any
値が設定されていない場合は、セルの上罫線を返します。値が設定されている場合は、セルを返します。
cellButtons
▸ cellButtons(value?): any
セルのcellButtonsを取得または設定します。
実例
activeSheet.getRange(2,-1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).cellButtons([caption:"Text"]]);
実例
var cellButtons = activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).cellButtons();
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
ICellButton[] |
セルのcellButtons。 |
戻り値
any
値が設定されていない場合は、セルのcellButtonsを返します。値が設定されている場合は、セルを返します。
cellPadding
▸ cellPadding(value?): any
セルのパディングを取得または設定します。
実例
// 次のサンプルコードは、透かしの周囲にセルパディングを追加します。
var type = new GC.Spread.Sheets.Style();
type.watermark = "User name";
type.cellPadding = "20";
type.labelOptions = {alignment:GC.Spread.Sheets.LabelAlignment.topLeft, visibility: GC.Spread.Sheets.LabelVisibility.visible};
activeSheet.setStyle(0, 1, type);
activeSheet.getRange(0, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).height(60);
activeSheet.getRange(-1, 1, -1, 1).width(150);
var combo = new GC.Spread.Sheets.CellTypes.ComboBox();
combo.items([{ text: "Oranges", value: "11k" }, { text: "Apples", value: "15k" }, { text: "Grape", value: "100k" }]);
combo.editorValueType(GC.Spread.Sheets.CellTypes.EditorValueType.text);
activeSheet.setCellType(2, 1, combo, GC.Spread.Sheets.SheetArea.viewport);
activeSheet.getCell(2, 1, GC.Spread.Sheets.SheetArea.viewport).watermark("ComboBox Cell Type").cellPadding('10 10 20 10');
activeSheet.getCell(2, 1, GC.Spread.Sheets.SheetArea.viewport).labelOptions({alignment: GC.Spread.Sheets.LabelAlignment.bottomCenter, foreColor: 'yellowgreen', font: 'bold 15px Arial'});
activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).height(60);
パラメータ
| 名前 | 型 |
|---|---|
value? |
string |
戻り値
any
値が設定されていない場合は、セルパディングの値を返します。値が設定されている場合は、セルを返します。
cellType
▸ cellType(value?): any
セルのセル型を取得または設定します。
実例
activeSheet.getRange(-1, 1, -1, 1, GC.Spread.Sheets.SheetArea.viewport).cellType(new GC.Spread.Sheets.CellTypes.CheckBox());
パラメータ
| 名前 | 型 |
|---|---|
value? |
Base |
戻り値
any
値が設定されていない場合は、セル型を返します。値が設定されている場合は、セルを返します。
clear
▸ clear(type): void
指定した領域をクリアします。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
type |
StorageType |
クリアタイプ。 |
戻り値
void
comment
▸ comment(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);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
Comment |
セルに設定するコメント。 |
戻り値
any
値が設定されていない場合は、セルのコメントを返します。値が設定されている場合は、セル範囲を返します。
defaultValue
▸ defaultValue(value?): any
セルのデフォルト値を取得または設定します。
実例
activeSheet.getCell(1,1).defaultValue(10);
activeSheet.getCell(1,3).defaultValue("=LastYear+1000");
パラメータ
| 名前 | 型 |
|---|---|
value? |
any |
戻り値
any
値が設定されていない場合は、デフォルト値を返します。値が設定されている場合は、セルを返します。
diagonalDown
▸ diagonalDown(value?): any
セルのdiagonalDownを取得または設定します。
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).diagonalDown(new GC.Spread.Sheets.LineBorder("blue", GC.Spread.Sheets.LineStyle.mediumDashed));
パラメータ
| 名前 | 型 |
|---|---|
value? |
LineBorder |
戻り値
any
値が設定されていない場合は、cell diagonalDown行を返します。 それ以外の場合は、セルを返します。
diagonalUp
▸ diagonalUp(value?): any
セルのdiagonalUpを取得または設定します。
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).diagonalUp(new GC.Spread.Sheets.LineBorder("blue", GC.Spread.Sheets.LineStyle.mediumDashed));
パラメータ
| 名前 | 型 |
|---|---|
value? |
LineBorder |
戻り値
any
値が設定されていない場合、cell diagonalUp行を返します。 それ以外の場合は、セルを返します。
dropDowns
▸ dropDowns(value?): any
セルのdropDownsを取得または設定します。
実例
activeSheet.getRange(2,-1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).dropDowns([caption:"Text"]]);
実例
var dropDowns = activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).dropDowns();
パラメータ
| 名前 | 型 |
|---|---|
value? |
IDropdown[] |
戻り値
any
値が設定されていない場合は、セルのdropDownsを返します。値が設定されている場合は、セルを返します。
font
▸ font(value?): any
セルのフォント（"normal normal normal 20px/normal Arial"など）を取得または設定します。
実例
activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).font("12pt Arial");
実例
activeSheet.getCell(1,1).font("8pt Arial");
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).font("12pt Arial");
パラメータ
| 名前 | 型 |
|---|---|
value? |
string |
戻り値
any
値が設定されていない場合は、セルのフォントを返します。値が設定されている場合は、セルを返します。
fontFamily
▸ fontFamily(value?): any
セルの fontFamily (「Arial」など) を取得または設定します。
実例
activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).fontFamily("Arial");
実例
activeSheet.getCell(1,1).fontFamily("Arial");
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).fontFamily("Arial");
パラメータ
| 名前 | 型 |
|---|---|
value? |
string |
戻り値
any
値が設定されていない場合は、セルのfontFamilyを返します。値が設定されている場合は、セルを返します。
fontSize
▸ fontSize(value?): any
セルの fontSize (「16px」など) を取得または設定します。
実例
activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).fontSize("16px");
実例
activeSheet.getCell(1,1).fontSize("16px");
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).fontSize("16px");
パラメータ
| 名前 | 型 |
|---|---|
value? |
string |
戻り値
any
値が設定されていない場合は、セルの fontSize を返します。値が設定されている場合は、セルを返します。
fontStyle
▸ fontStyle(value?): any
セルの fontStyle (「italic」など) を取得または設定します。
実例
activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).fontStyle("italic");
実例
activeSheet.getCell(1,1).fontStyle("italic");
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).fontStyle("italic");
パラメータ
| 名前 | 型 |
|---|---|
value? |
string |
戻り値
any
値が設定されていない場合は、セルの fontStyle を返します。値が設定されている場合は、セルを返します。
fontWeight
▸ fontWeight(value?): any
セルの fontWeight (「bold」など) を取得または設定します。
実例
activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).fontWeight("bold");
実例
activeSheet.getCell(1,1).fontWeight("bold");
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).fontWeight("bold");
パラメータ
| 名前 | 型 |
|---|---|
value? |
string |
戻り値
any
値が設定されていない場合は、セルの fontWeight を返します。値が設定されている場合は、セルを返します。
foreColor
▸ foreColor(value?): any
セルのテキストの色（"red"、"#FFFF00"、"rgb(255,0,0)"、"Accent 5"など）を取得または設定します。
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).foreColor("blue");
パラメータ
| 名前 | 型 |
|---|---|
value? |
string |
戻り値
any
値が設定されていない場合は、セルの前景色を返します。値が設定されている場合は、セルを返します。
formatter
▸ formatter(value?): any
セルのフォーマッターを取得または設定します。
実例
activeSheet.getCell(1,1).formatter("0.000%");
実例
activeSheet.getCell(1, -1).formatter("0.000%");
activeSheet.getCell(1,0).value("2");
実例
activeSheet.getCell(-1, 0).formatter("0.000%");
activeSheet.getCell(0,0).value("2");
パラメータ
| 名前 | 型 |
|---|---|
value? |
string | GeneralFormatter |
戻り値
any
値が設定されていない場合は、セルのフォーマッター文字列またはオブジェクトを返します。値が設定されている場合は、セルを返します。
formula
▸ formula(value?, autoAdjustReference?): any
セルの数式を取得または設定します。
実例
activeSheet.getCell(0,2).formula("DATEDIF(DATE(2003,1,1),DATE(2016,1,1),\"Y\")");
activeSheet.getRange(2,2,100,1).formula("=A3+$A$1"); // all the cells are "=A3+$A$1"
activeSheet.getRange(2,2,100,1).formula("=A3+$A$1", true); // the first cell is "=A3+$A$1", the second cell is "=A4+$A$1", ...
パラメータ
| 名前 | 型 |
|---|---|
value? |
string |
autoAdjustReference? |
boolean |
戻り値
any
値が設定されていない場合は、セルの数式を返します。値が設定されている場合は、セルを返します。
hAlign
▸ hAlign(value?): any
セルの内容の水平方向の配置を取得または設定します。
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).hAlign(GC.Spread.Sheets.HorizontalAlign.right);
パラメータ
| 名前 | 型 |
|---|---|
value? |
HorizontalAlign |
戻り値
any
値が設定されていない場合は、セルの内容の水平方向の配置を返します。値が設定されている場合は、セルを返します。
height
▸ height(value?): any
行の高さ（ピクセル単位）を取得または設定します。
実例
activeSheet.getRange(0, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).height(90);
パラメータ
| 名前 | 型 |
|---|---|
value? |
number |
戻り値
any
値が設定されていない場合は、行の高さを返します。値が設定されている場合は、行を返します。
hidden
▸ hidden(value?): any
シートが保護されているときにセルの数式が表示されるかどうかを示します。
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).hidden(true);
パラメータ
| 名前 | 型 |
|---|---|
value? |
boolean |
戻り値
any
値が設定されていない場合は、セルの数式が非表示かどうかを返します。値が設定されている場合は、セルを返します。
imeMode
▸ imeMode(value?): any
セルのIMEモードを取得または設定します。
非推奨 現在、このプロパティは IE（Internet Explorer）でのみ動作します。
実例
activeSheet.getCell(0, 0).imeMode(GC.Spread.Sheets.ImeMode.disabled);
//または
var style = new GC.Spread.Sheets.Style();
style.imeMode = GC.Spread.Sheets.ImeMode.disabled;
activeSheet.setStyle(0, 0, style);
実例
activeSheet.getRange(2, -1, 1, -1).imeMode(GC.Spread.Sheets.ImeMode.active);
実例
activeSheet.getRange(-1, 2, -1, 1).imeMode(GC.Spread.Sheets.ImeMode.auto);
パラメータ
| 名前 | 型 |
|---|---|
value? |
ImeMode |
戻り値
any
値が設定されていない場合は、セルのIMEモードを返します。値が設定されている場合は、セルを返します。
isVerticalText
▸ isVerticalText(value?): any
セルのテキストが垂直かどうかを取得または設定します。
実例
activeSheet.getRange(2,-1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).isVerticalText(false);
activeSheet.setText(2,0,"This is a test");
実例
activeSheet.getCell(1,1).isVerticalText(true);
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).isVerticalText(true);
パラメータ
| 名前 | 型 |
|---|---|
value? |
boolean |
戻り値
any
値が設定されていない場合は、セルのテキストが垂直かどうか示す値を返します。 それ以外の場合は、セルを返します。
labelOptions
▸ labelOptions(value?): any
セルラベルのオプションを取得または設定します。
実例
//次のサンプルコードは、ウォーターマーク用のラベルオプションを設定します。
var type = new GC.Spread.Sheets.Style();
type.watermark = "User name";
type.cellPadding = "20";
type.labelOptions = {alignment:GC.Spread.Sheets.LabelAlignment.topLeft, visibility: GC.Spread.Sheets.LabelVisibility.visible};
activeSheet.setStyle(0, 1, type);
activeSheet.getRange(0, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).height(60);
activeSheet.getRange(-1, 1, -1, 1).width(150);
var combo = new GC.Spread.Sheets.CellTypes.ComboBox();
combo.items([{ text: "Oranges", value: "11k" }, { text: "Apples", value: "15k" }, { text: "Grape", value: "100k" }]);
combo.editorValueType(GC.Spread.Sheets.CellTypes.EditorValueType.text);
activeSheet.setCellType(2, 1, combo, GC.Spread.Sheets.SheetArea.viewport);
activeSheet.getCell(2, 1, GC.Spread.Sheets.SheetArea.viewport).watermark("ComboBox Cell Type").cellPadding('10 10 20 10');
activeSheet.getCell(2, 1, GC.Spread.Sheets.SheetArea.viewport).labelOptions({alignment: GC.Spread.Sheets.LabelAlignment.bottomCenter, foreColor: 'yellowgreen', font: 'bold 15px Arial'});
activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).height(60);
パラメータ
| 名前 | 型 |
|---|---|
value? |
ILabelOptions |
戻り値
any
値が設定されていない場合、セルラベルオプションの値を返します。値が設定されている場合は、セルを返します。
locked
▸ locked(value?): any
セルがロックされているかどうかを取得または設定します。シートが保護されている場合、ロックされたセルは編集できません。
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).locked(true);
パラメータ
| 名前 | 型 |
|---|---|
value? |
boolean |
戻り値
any
値が設定されていない場合は、セルがロックされているかどうかを返します。値が設定されている場合は、セルを返します。
mask
▸ mask(value?): any
セルマスクを取得または設定します。
実例
// 次のサンプルコードは、セルマスクを設定します。
var style = new GC.Spread.Sheets.Style();
var pattern = "[a0_]{8}";
style.pattern = pattern;
activeSheet.setStyle(0, 1, style);
activeSheet.getCell(0, 1, GC.Spread.Sheets.SheetArea.viewport).mask({ pattern: pattern});
パラメータ
| 名前 | 型 |
|---|---|
value? |
IMaskType |
戻り値
any
値が設定されていない場合は、セルマスクの値を返します。値が設定されている場合は、セルを返します。
quotePrefix
▸ quotePrefix(value?): any
セルの引用プレフィックスを取得または設定します。
実例
activeSheet.getCell(1,1).quotePrefix(true);
パラメータ
| 名前 | 型 |
|---|---|
value? |
boolean |
戻り値
any
値が設定されていない場合は、quotePrefixの内容を返します。 それ以外の場合は、セルを返します。
resizable
▸ resizable(value?): any
ユーザーが行または列のサイズを変更できるかどうかを取得または設定します。
実例
activeSheet.getRange(-1, 3, -1, 1. GC.Spread.Sheets.SheetArea.viewport).resizable(true);
パラメータ
| 名前 | 型 |
|---|---|
value? |
boolean |
戻り値
any
値が設定されていない場合は、ユーザーが行のサイズを変更できるかどうかを返します。値が設定されている場合は、行または列を返します。
setBorder
▸ setBorder(border, option): void
指定した領域の罫線を設定します。
実例
//次のサンプルコードは罫線を作成します。
sheet.getCell(1, 1).borderTop(new GC.Spread.Sheets.LineBorder("#F0F8FF",GC.Spread.Sheets.LineStyle.double));
sheet.getCell(1, 1).borderLeft(new GC.Spread.Sheets.LineBorder("#F0F8FF",GC.Spread.Sheets.LineStyle.hair));
sheet.getCell(1, 1).borderRight(new GC.Spread.Sheets.LineBorder("#FAEBD7",GC.Spread.Sheets.LineStyle.dashDot));
sheet.getCell(1, 1).borderBottom(new GC.Spread.Sheets.LineBorder("#00FFFF",GC.Spread.Sheets.LineStyle.medium));
sheet.getRange(-1, 5, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderTop(new GC.Spread.Sheets.LineBorder("#F0FFFF",GC.Spread.Sheets.LineStyle.medium));
sheet.getRange(-1, 5, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderLeft(new GC.Spread.Sheets.LineBorder("#F5F5DC",GC.Spread.Sheets.LineStyle.medium));
sheet.getRange(-1, 5, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderRight(new GC.Spread.Sheets.LineBorder("#FF02FF", GC.Spread.Sheets.LineStyle.dashDot));
sheet.getRange(-1, 5, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderBottom (new GC.Spread.Sheets.LineBorder("#FFE4C4",GC.Spread.Sheets.LineStyle.thin));
sheet.getRange(2, 2, 2, 2, GC.Spread.Sheets.SheetArea.viewport).setBorder(new GC.Spread.Sheets.LineBorder("#8A2BE2",GC.Spread.Sheets.LineStyle.thick), { all:true });
sheet.getRange(5, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).borderTop( new GC.Spread.Sheets.LineBorder("#A52A2A",GC.Spread.Sheets.LineStyle.mediumDashed));
sheet.getRange(5, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).borderLeft( new GC.Spread.Sheets.LineBorder("#FF02FF",GC.Spread.Sheets.LineStyle.medium));
sheet.getRange(5, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).borderRight(new GC.Spread.Sheets.LineBorder("#5F9EA0", GC.Spread.Sheets.LineStyle.dashDot));
sheet.getRange(5, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).borderBottom(new GC.Spread.Sheets.LineBorder("#6495ED",GC.Spread.Sheets.LineStyle.dotted));
sheet.getRange(5, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).diagonalUp(new GC.Spread.Sheets.LineBorder("#FF02FF",GC.Spread.Sheets.LineStyle.dotted));
sheet.getRange(5, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).diagonalDown(new GC.Spread.Sheets.LineBorder("#6495ED",GC.Spread.Sheets.LineStyle.medium));
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
border |
LineBorder |
罫線。 |
option |
ISetBorderOptions |
セル範囲のどの部分に設定するかを指定します。optionオブジェクトには{all:true, left:true, top:true, right:true, bottom:true, diagonalUp:true, diagonalDown:true, outline:true,inside:true, innerHorizontal:true, innerVertical:true}が含まれます。 |
戻り値
void
setStyle
▸ setStyle(value): void
セルのスタイルを設定します。
実例
let style = new GC.Spread.Sheets.Style();
style.formatter = "#,##0.00";
sheet.getRange("E5:F10").setStyle(style);
sheet.getRange(0,0,4,4).setStyle(style);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value |
Style |
スタイル。 |
戻り値
void
setStyleName
▸ setStyleName(value): void
セルのスタイル名を設定します。
実例
let style = new GC.Spread.Sheets.Style();
style.name = "bold_style";
style.font = "bold 12px sans-serif";
sheet.addNamedStyle(style);
sheet.getRange("A1:D3").setStyleName("bold_style");
sheet.getRange(5,5,10,10).setStyleName("bold_style");
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value |
string |
スタイル名。 |
戻り値
void
showEllipsis
▸ showEllipsis(value?): any
セルのellipsisプロパティを取得または設定します。
実例
activeSheet.getRange(2,-1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).showEllipsis(false);
activeSheet.setText(2,0,"This is a test");
実例
activeSheet.getCell(1,1).showEllipsis(true);
パラメータ
| 名前 | 型 |
|---|---|
value? |
boolean |
戻り値
any
値が設定されていない場合、セルのellipsisプロパティかどうかを返します。
shrinkToFit
▸ shrinkToFit(value?): any
セルのサイズに収まるようにセルのテキストを縮小するかどうかを取得または設定します。
実例
activeSheet.getRange(2,-1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).shrinkToFit(false);
activeSheet.setText(2,0,"This is a test");
実例
activeSheet.getCell(1,1).shrinkToFit(true);
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).shrinkToFit(true);
パラメータ
| 名前 | 型 |
|---|---|
value? |
boolean |
戻り値
any
値が設定されていない場合は、セルに収まるようにテキストを縮小するかどうかを返します。値が設定されている場合は、セルを返します。
tabStop
▸ tabStop(value?): any
ユーザーが［Tab］キーを使用してセルにフォーカスを設定できるかどうかを示す値を取得または設定します。
実例
activeSheet.getCell(1,1).tabStop(false);
activeSheet.getRange(1, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).tabStop(false);
activeSheet.getRange(-1, 1, -1, 1, GC.Spread.Sheets.SheetArea.viewport).tabStop(false);
パラメータ
| 名前 | 型 |
|---|---|
value? |
boolean |
戻り値
any
値が設定されていない場合は、ユーザーが［Tab］キーを使用してセルにフォーカスを設定できるかどうかを返します。値が設定されている場合は、セルを返します。
tag
▸ tag(value?): any
セルのタグを取得または設定します。
実例
activeSheet.getCell(1,1).tag("cell tag");
パラメータ
| 名前 | 型 |
|---|---|
value? |
any |
戻り値
any
値が設定されていない場合は、タグ値を返します。値が設定されている場合は、セルを返します。
text
▸ text(value?): any
セルの書式付きテキストを取得または設定します。
実例
activeSheet.getCell(1,1).text("cell object");
パラメータ
| 名前 | 型 |
|---|---|
value? |
string |
戻り値
any
値が設定されていない場合は、セルのテキストを返します。値が設定されている場合は、セルを返します。
textDecoration
▸ textDecoration(value?): any
セルのテキストに追加される装飾のタイプを取得または設定します。
実例
activeSheet.getRange(1, -1, 1, -1).textDecoration(GC.Spread.Sheets.TextDecorationType.overline | GC.Spread.Sheets.TextDecorationType.underline);
パラメータ
| 名前 | 型 |
|---|---|
value? |
TextDecorationType |
戻り値
any
値が設定されていない場合は、装飾のタイプを返します。値が設定されている場合は、セルを返します。
textDirection
▸ textDirection(value?): any
セル内のテキストの表示方向のタイプを取得または設定します。
実例
activeSheet.getRange(1, -1, 1, -1).textDirection(GC.Spread.Sheets.TextDirectionType.rightToLeft);
パラメータ
| 名前 | 型 |
|---|---|
value? |
TextDirectionType |
戻り値
any
値が設定されていない場合は、方向のタイプを返します。値が設定されている場合は、セルを返します。
textIndent
▸ textIndent(value?): any
セルのテキストインデントを取得または設定します。
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).textIndent(1);
パラメータ
| 名前 | 型 |
|---|---|
value? |
number |
戻り値
any
値が設定されていない場合は、セルのテキストインデントを返します。値が設定されている場合は、セルを返します。
textOrientation
▸ textOrientation(value?): any
セルのテキスト回転角度を取得または設定します。
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).textOrientation(66);
パラメータ
| 名前 | 型 |
|---|---|
value? |
number |
戻り値
any
値が設定されていない場合は、セルのテキスト回転角度を返します。値が設定されている場合は、セルを返します。
themeFont
▸ themeFont(value?): any
セルのテーマフォントを取得または設定します。
実例
activeSheet.getCell(-1, 0).themeFont("Body");
activeSheet.getCell(0,0).value("Test");
パラメータ
| 名前 | 型 |
|---|---|
value? |
string |
戻り値
any
値が設定されていない場合は、セルのテーマフォントを返します。値が設定されている場合は、セルを返します。
toHtml
▸ toHtml(headerOptions?, includeStyle?): string
指定された領域からHTMLコンテンツを取得します。
実例
activeSheet.getRange(0, 0, 10, 10).toHtml();
パラメータ
| 名前 | 型 |
|---|---|
headerOptions? |
HeaderOptions |
includeStyle? |
boolean |
戻り値
string
セルのテキスト、セル結合、セルのスタイルを含むHTMLコンテンツ。
vAlign
▸ vAlign(value?): any
セルの内容の垂直方向の配置を取得または設定します。
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).vAlign(GC.Spread.Sheets.VerticalAlign.top);
パラメータ
| 名前 | 型 |
|---|---|
value? |
VerticalAlign |
戻り値
any
値が設定されていない場合は、セルの内容の垂直方向の配置を返します。値が設定されている場合は、セルを返します。
validator
▸ validator(value?): any
セルのデータバリデーターを取得または設定します。
実例
spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createDateValidator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between, new Date(2012, 11, 31), new Date(2013, 11, 31));
dv.showInputMessage(true);
dv.inputMessage("Enter a date between 12/31/2012 and 12/31/2013.");
dv.inputTitle("Tip");
activeSheet.getCell(0,0).validator(dv);
実例
spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createDateValidator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between, new Date(2012, 11, 31), new Date(2013, 11, 31));
dv.showInputMessage(true);
dv.inputMessage("Enter a date between 12/31/2012 and 12/31/2013.");
dv.inputTitle("Tip");
activeSheet.getCell(1, -1).validator(dv);
実例
spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createListValidator("1,2,3");
dv.showInputMessage(true);
dv.inputMessage("Value must be 1,2 or 3");
dv.inputTitle("tip");
activeSheet.setDataValidator(-1,0,dv);
パラメータ
| 名前 | 型 |
|---|---|
value? |
DefaultDataValidator |
戻り値
any
値が設定されていない場合は、セルのデータバリデーターを返します。値が設定されている場合は、セルを返します。
value
▸ value(value?): any
セルの書式なしの値を取得または設定します。
実例
activeSheet.getCell(1,1).value(10);
パラメータ
| 名前 | 型 |
|---|---|
value? |
any |
戻り値
any
値が設定されていない場合は、セル値を返します。値が設定されている場合は、セルを返します。
visible
▸ visible(value?): any
行または列が表示されるかどうかを取得または設定します。
実例
activeSheet.getCell(-1, 0).visible(false);
パラメータ
| 名前 | 型 |
|---|---|
value? |
boolean |
戻り値
any
値が設定されていない場合は、行または列が表示されるかどうかを返します。値が設定されている場合は、行または列を返します。
watermark
▸ watermark(value?): any
セルの透かしの内容を取得または設定します。
実例
activeSheet.getCell(1,1).watermark("lightgreen");
パラメータ
| 名前 | 型 |
|---|---|
value? |
string |
戻り値
any
値が設定されていない場合は、透かしの内容を返します。値が設定されている場合は、セルを返します。
width
▸ width(value?): any
列の幅（ピクセル単位）を取得または設定します。
実例
activeSheet.getCell(-1, 0).width(20);
パラメータ
| 名前 | 型 |
|---|---|
value? |
number |
戻り値
any
値が設定されていない場合は、列の幅を返します。値が設定されている場合は、列を返します。
wordWrap
▸ wordWrap(value?): any
セルのテキストを折り返すかどうかを取得または設定します。
実例
activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).wordWrap(true);
パラメータ
| 名前 | 型 |
|---|---|
value? |
boolean |
戻り値
any
値が設定されていない場合は、セルのテキストを折り返すかどうかを返します。値が設定されている場合は、セルを返します。