Inputman.GcComboBox

GcComboBox クラス

GcComboBox

階層

GcComboBox

コンストラクタ

constructor

プロパティ

メソッド

イベント

コンストラクタ

constructor

new GcComboBox(ele: HTMLSelectElement, option?: ComboBoxConfig): GcComboBox

var select = document.getElementById('select');
var config = {
    visibleItems: 5,
    dropDownWidth: 300,
    itemHeight: 30,
    colHeaderHeight: 25,
    items: [
        {id: 0, name: 'item0'},
        {id: 1, name: 'item1'},
        {id: 2, name: 'item2'},
        {id: 3, name: 'item3'},
        {id: 4, name: 'item4'},
        {id: 5, name: 'item5'},
        {id: 6, name: 'item6'},
        {id: 7, name: 'item7'},
    ],
    columns: [
         {name: 'id', label: 'ID', width: 70, isValuePath: true, visible: true, clickSort: true},
         {name: 'name', label: 'Name', width: 70, visible: true, clickSort: true},
    ],
    allowResize: true,
    virtualMode: true,
    overflow: GC.InputMan.ScrollBars.Both,
    formatItem: function(args){
        args.itemObject.id = "ID : " + args.itemObject.id;
    },
    generatingItem: function(args){
        args.item.classList.add(args.index % 2 ? "odd" : "even");
    }
};
var combo = new GC.InputMan.GcComboBox(select, config);

引数

ele: HTMLSelectElement
オプション option: ComboBoxConfig

indicate GcComboBox settings.

戻り値 GcComboBox

プロパティ

acceptsCrlf

acceptsCrlf: CrLfMode

文字列をコピー、切り取り、および貼り付けるときに改行コード（CrLf文字）をどのように処理するかを設定または取得します。

参照：setAcceptsCrlf

allowColumnResize

allowColumnResize: boolean

ドロップダウンリストの列幅をユーザーが変更できるかどうかを設定または取得します。

参照：setAllowColumnResize

allowDropDownResize

allowDropDownResize: boolean

ドロップダウンリストのリサイズを許可するかどうかを設定または取得します。

参照：setAllowDropDownResize

autoCompleteMatchMode

autoCompleteMatchMode: AutoCompleteMatchMode

オートコンプリートで検索時の時のあいまいさを設定もしくは取得します。

autoCompleteMode

autoCompleteMode: AutoCompleteMode

オートコンプリートの実行方法を設定もしくは取得します。

autoDropDown

autoDropDown: boolean

コントロールがフォーカスを取得すると、自動的にドロップダウンを開くかどうかを設定または取得します。

参照：setAutoDropDown

autoFilter

autoFilter: AutoFilter

オートフィルターの種類を設定または取得します。

参照：setAutoFilter

autoScale

autoScale: boolean

テキストが入力幅から見きれてしまうときに、テキストを入力幅に合わせて縮小するかどうかを設定または取得します。

参照：setAutoScale

autoSelect

autoSelect: boolean

コンボボックスにテキストを入力したときに自動的にアイテムを選択するかどうかを設定または取得します。

参照：setAutoSelect

checkedIndices

checkedIndices: number[]

チェックしたアイテムのインデックスを取得または設定します。

参照：getCheckedIndices 参照：setCheckedIndices

checkedItems

checkedItems: object[] | string[]

チェックしたアイテムを取得または設定します。

参照：getCheckedItems 参照：setCheckedItems

checkedValues

checkedValues: number[] | string[] | boolean[] | object[]

alueMemberPathを使用してチェックされたアイテム値の配列を取得または設定します。

参照：getCheckedValues 参照：setCheckedValues

読み取り専用 componentName

componentName: string

コンポーネント名（'GcComboBox'）を取得します。

container

container: HTMLElement

コントロールを配置しているコンテナを設定または取得します。コントロールの下部にドロップダウンを表示するために十分なスペースがあるかどうかをチェックし、ドロップダウンを反転してコントロールの上部に表示するかどうかを決定します。

参照：setContainer

copiedMessage

copiedMessage: string

コピーボタンを押下した後にツールチップで表示するテキストを設定もしくは取得します。

copyMessage

copyMessage: string

コピーボタンのマウスオーバーでツールチップで表示するテキストを設定もしくは取得します。

読み取り専用 displayMemberPath

displayMemberPath: string

ドロップダウンリスト項目のパスを取得します。

読み取り専用 displayText

displayText: string

コンボボックスに表示されているテキストを取得します。

参照：getDisplayText

dropDownButtonVisible

dropDownButtonVisible: boolean

ドロップダウンボタンを動的に表示または非表示するかどうかの値を設定または取得します。

参照：setDropDownButtonVisible

読み取り専用 dropDownTree

dropDownTree: IComboBoxDropDownTree

ドロップダウンリストのツリービューのインスタンスを取得します。

読み取り専用 dropDownType

dropDownType: ComboDropDownType

ドロップダウンリストの表示形式を取得します。

読み取り専用 dropDownWindow

dropDownWindow: IDropDownContainer

このコントロールのドロップダウンウィンドウを取得します。ドロップダウンがない場合は undefined を返し、複数のドロップダウンがある場合は最後のドロップダウンを返します。

参照：getDropDownWindow

editMode

editMode: EditMode

コンボボックスのエディタを編集可能にするかどうかを設定または取得します。

参照：setEditable

editable

editable: boolean

コンボボックスのエディタを編集可能にするかどうかを設定または取得します。

参照：setEditable

ellipsis

ellipsis: EllipsisMode

文字列がコントロールの幅よりも長いときに、省略文字を表示するかどうかを設定または取得します。

参照：setEllipsis

ellipsisString

ellipsisString: string

コントロールに表示する省略文字を設定または取得します。

参照：setEllipsisString

enabled

enabled: boolean

コントロールやオブジェクトを有効にするかどうかを示す値を設定または取得します。

参照：setEnabled

exitOnEnterKey

exitOnEnterKey: ExitKey

フォーカスの移動方法を設定または取得します。

参照：setExitOnEnterKey

exitOnLeftRightKey

exitOnLeftRightKey: ExitOnLeftRightKey

矢印キーを使ったフォーカスの移動方法を設定または取得します。

参照：setExitOnLeftRightKey

floatingLabelDirection

floatingLabelDirection: FloatingLabelDirection

フローティングラベルの表示位置を設定もしくは取得します。

floatingLabelText

floatingLabelText: string

フローティングラベルの表示テキストを設定もしくは取得します。

floatingLabelType

floatingLabelType: FloatingLabelType

フローティングラベルの表示パターンを設定もしくは取得します。

height

height: number | string

フローティングラベルの高さを設定もしくは取得します。

helpContent

helpContent: string

ヘルプボタンのマウスオーバーでツールチップで表示するテキストを設定もしくは取得します。

highlightText

highlightText: boolean

コントロールがフォーカスを受け取ったときに、テキストを選択するかどうかを設定または取得します。

参照：setHighlightText

読み取り専用 isOverwrite

isOverwrite: boolean

現在の編集モードが上書きに設定されているかどうかを取得します。

参照：getIsOverwrite

items

items: number[] | string[] | boolean[] | object[]

ドロップダウンリストのアイテムを含む配列データを取得または設定します。

参照：getItems 参照：setItems

maxHeight

maxHeight: number | string

フローティングラベルの最大高を設定もしくは取得します。

maxWidth

maxWidth: number | string

フローティングラベルの最大高を設定もしくは取得します。

minHeight

minHeight: number | string

フローティングラベルの最小高を設定もしくは取得します。

minScaleFactor

minScaleFactor: number

テキストを縮小するときの最小倍率を設定または取得します。

参照：setMinScaleFactor

minWidth

minWidth: number | string

フローティングラベルの最小幅を設定もしくは取得します。

multipleItemSeparator

multipleItemSeparator: string

isMultiSelectがtrueの場合の区切り文字を設定します。

readOnly

readOnly: boolean

コントロールを読み取り専用モードにするかどうかを取得または設定します。

参照：getReadOnly 参照：setReadOnly

selectedIndex

selectedIndex: number

選択したアイテムのインデックスを取得または設定します。

参照：getSelectedIndex 参照：setSelectedIndex

selectedItem

selectedItem: string | object

選択されたアイテムを取得または設定します。

参照：getSelectedItem 参照：setSelectedItem

selectedValue

selectedValue: number | string | boolean | object

valueMemberPathを使用して選択されたアイテムの値を取得または設定します。

参照：getSelectedValue 参照：setSelectedValue

showClearButton

showClearButton: boolean

クリアボタンを表示するかどうかを設定または取得します。

参照：setShowClearButton

showCopyButton

showCopyButton: boolean

コピーボタンを表示するかどうかを設定もしくは取得します。

showHelpButton

showHelpButton: boolean

ヘルプボタンを表示するかどうかを設定もしくは取得します。

showTip

showTip: boolean

セルの内容が見切れている場合に、すべてのセルのチップを表示するかどうかを設定または取得します。

参照：setShowTip

spinButton

spinButton: SpinButtonAlignment

コンボボックスにスピンボタンを設定または取得します。

参照：addSpinButton

spinWheel

spinWheel: boolean

マウスホイールを使用してスピン動作を許可するかどうかを設定または取得します。

参照：setSpinWheel

tabIndex

tabIndex: number

コントロールのtabIndexを取得または設定します。

text

text: string

コントロールにテキストを設定または取得します。

参照：setText

useClipboard

useClipboard: boolean

クリップボードにアクセスすることを許可するかどうかを設定または取得します。

参照：setUseClipboard

読み取り専用 valueMemberPath

valueMemberPath: string

ドロップダウンリスト値のパスを取得します。

visible

visible: boolean

コントロールをページに表示するかどうかを示す値を設定または取得します。

参照：setVisible

watermarkDisplayNullText

watermarkDisplayNullText: string

コントロールにフォーカスがなく未入力のときの代替テキストを設定または取得します。

参照：setWatermarkDisplayNullText

watermarkNullText

watermarkNullText: string

コントロールにフォーカスがあり未入力のときの代替テキストを設定または取得します。

参照：setWatermarkNullText

width

width: number | string

フローティングラベルの幅を設定もしくは取得します。

メソッド

addEventListener

addEventListener(eventType: GcComboBoxEvent, listener: (sender: this, eventArgs?: object): void): void

指定したイベントが発生したときに実行する処理を設定します。

引数
- eventType: GcComboBoxEvent
  
  イベントの種類を表す文字列（大文字と小文字を区別しません）
- listener: (sender: this, eventArgs?: object): void
  イベントが発生したときに実行する処理
```
var selectedChangedHandler = function(){
    let selectedValues = combo.getSelectedValue();
    console.log(selectedValues);
}
combo.addEventListener(GC.InputMan.GcComboBoxEvent.SelectedChanged, selectedChangedHandler);
```
  - - (sender: this, eventArgs?: object): void
    - 引数
      - sender: this
      - オプション eventArgs: object
      戻り値 void
戻り値 void

addItem

addItem(item: number | string | boolean | object): void

ドロップダウンリストにアイテムを追加します。

引数
- item: number | string | boolean | object
  
  追加するアイテム
戻り値 void

addItems

addItems(items: number[] | string[] | boolean[] | object[]): void

リストにアイテムの配列を追加します。

引数
- items: number[] | string[] | boolean[] | object[]
  
  アイテムの配列
戻り値 void

addSpinButton

addSpinButton(leftSide: boolean): void

コンボボックスにスピンボタンを追加します。
参照：spinButton

引数
- leftSide: boolean
  
  スピンボタンを表示する位置を指定します。Trueにすると左側に、それ以外は右側に表示されます。
戻り値 void

autoScaleText

autoScaleText(): void

テキストが入力幅から見きれてしまうときに、入力幅に合わせてテキストを調整します。

戻り値 void

clearChecked

clearChecked(): void

アイテムのチェックを解除します。

戻り値 void

clearItems

clearItems(): void

すべてのドロップダウンリストの項目をクリアします。

戻り値 void

clearSelected

clearSelected(): void

アイテムの選択を解除します。

戻り値 void

doSpinDown

doSpinDown(decrement?: number): void

スピン機能を使ってコントロールの値を減少します。

引数
- オプション decrement: number
  
  値の減少量。省略した場合は 1。
戻り値 void

doSpinUp

doSpinUp(increment?: number): void

スピン機能を使ってコントロールの値を増加します。

引数
- オプション increment: number
  
  値の増加量。省略した場合は 1。
戻り値 void

filter

filter(filterInfos: FilterInfo[] | FilterFunc): void

フィルタ条件に合致したアイテムでドロップダウンリストをリロードします。 filterInfos が nullの場合、フィルター条件をクリアします。

var filters = [{name: 'id', comparator: FilterComparator.Equal, filterString: '3'}];
// item['id'] === '3' の条件でフィルタリングします
combobox.filter(filters);

// フィルター条件をクリアします
combobox.filter(null)

// フィルター条件を関数で定義します。
combobox.filter(function (v) {
    return v.id > parseInt(input.value);
});

引数

filterInfos: FilterInfo[] | FilterFunc

フィルター条件(filterInfo)の配列

戻り値 void

findString

findString(str: string, start?: number, col?: string): number

指定した列で検索文字列を含む最初のアイテムを見つけます。

引数
- str: string
  
  検索する文字列
- オプション start: number
  
  検索を開始する位置
- オプション col: string
  
  検索する列
戻り値 number

検索で見つかった最初のアイテムのインデックス

findStringExact

findStringExact(str: string, start?: number, col?: string): number

指定した列で検索文字列と一致する最初のアイテムを見つけます。

引数
- str: string
  
  検索する文字列
- オプション start: number
  
  検索を開始する位置
- オプション col: string
  
  検索する列
戻り値 number

検索で見つかった最初のアイテムのインデックス

getCheckedIndices

getCheckedIndices(): number[]

チェックしたアイテムのインデックスを取得します。
参照：checkedIndices

戻り値 number []

チェックしたアイテムのインデックスの配列

getCheckedItems

getCheckedItems(): object[]

チェックしたアイテムを取得します。
参照：checkedItems

戻り値 object []

チェックしたアイテムの配列

getCheckedValues

getCheckedValues(): number[] | string[] | boolean[] | object[]

valueMemberPathを使用してチェックされたアイテム値の配列を取得します。
参照：checkedValues

戻り値 number [] | string [] | boolean [] | object []

チェックしたアイテムの値の配列

getDisplayText

getDisplayText(): string

コンボボックスに表示されているテキストを取得します。
参照：displayText

戻り値 string

コンボボックスに表示されているテキスト

getDropDownColumnWidth

getDropDownColumnWidth(col: string): number | null

ドロップダウンリストの特定の列の幅を取得します。

const gcComboBox = new GC.InputMan.GcComboBox(document.getElementById("combobox1"), {
    items: [
        {
            id: 1,
            name: 'Jenny'
        },
        {
            id: 2,
            name: 'Mike'
        }],
    columns: [
        {
            "name": "id",
            "width": 80,
        },
        {
            "name": "name",
            width: 200
        }],
    displayMemberPath: 'name',
    width: 200,
    height: 30,
    dropDownWidth: 300
});

// ドロップダウンリストの特定の列の幅を取得します。
const width = gcComboBox.getDropDownColumnWidth('name');

引数

col: string

列名

戻り値 number | null

getDropDownWindow

getDropDownWindow(): IDropDownContainer

このコントロールのドロップダウンウィンドウを取得します。ドロップダウンがない場合は undefined を返し、複数のドロップダウンがある場合は最後のものを返します。
参照：dropDownWindow

戻り値 IDropDownContainer

このコントロールのドロップダウンウィンドウを取得します。

getIsOverwrite

getIsOverwrite(): boolean

現在の編集モードが上書きに設定されているかどうかを取得します。
参照：isOverwrite

戻り値 boolean

上書きモードはtrue、挿入モードはfalse。

getItems

getItems(): number[] | string[] | boolean[] | object[]

ドロップダウンリストのアイテムを含む配列データを取得します。
参照：items

戻り値 number [] | string [] | boolean [] | object []

アイテムの配列

getReadOnly

getReadOnly(): boolean

コントロールを読み取り専用モードにするかどうかを取得します。
参照：readOnly

戻り値 boolean

読み取り専用の場合はtrue、それ以外はfalse。

getSelectedIndex

getSelectedIndex(): number

選択したアイテムのインデックスを取得します。
参照：selectedIndex

戻り値 number

選択したアイテムのインデックス

getSelectedItem

getSelectedItem(): object | string

選択されたアイテムを取得します。
参照：selectedItem

戻り値 object | string

選択されたアイテム

getSelectedValue

getSelectedValue(): number | string | boolean | object

valueMemberPathを使用して選択されたアイテムの値を取得します。
参照：selectedValue

戻り値 number | string | boolean | object

選択されたアイテムの値

insertItem

insertItem(item: number | string | boolean | object, start: number): void

ドロップダウンリストの指定した位置にアイテムを挿入します。

引数
- item: number | string | boolean | object
  
  挿入するアイテム
- start: number
  
  アイテムを挿入するインデックス位置
戻り値 void

insertItems

insertItems(items: number[] | string[] | boolean[] | object[], start: number): void

ドロップダウンリストの指定した位置に複数のアイテムを挿入します。

引数
- items: number[] | string[] | boolean[] | object[]
  
  挿入するアイテム
- start: number
  
  アイテムを挿入するインデックス位置
戻り値 void

removeEventListener

removeEventListener(eventType: GcComboBoxEvent, listener?: (sender: this, eventArgs?: object): void): void

addEventListenerで登録したイベントを削除します。

引数
- eventType: GcComboBoxEvent
  
  イベントの種類を表す文字列（大文字と小文字を区別しません）
- オプション listener: (sender: this, eventArgs?: object): void
  コントロールから削除するイベント処理
```
combo.removeEventListener(GC.InputMan.GcComboBoxEvent.SelectedChanged, selectedChangedHandler);
```
  - - (sender: this, eventArgs?: object): void
    - 引数
      - sender: this
      - オプション eventArgs: object
      戻り値 void
戻り値 void

setAcceptsCrlf

setAcceptsCrlf(v: CrLfMode): void

文字列をコピー、切り取り、および貼り付けるときに改行コード（CrLf文字）をどのように処理するかを示す値を設定します。
参照：acceptsCrlf

引数
- v: CrLfMode
  
  改行コードの処理方法を示す値（CrLfMode列挙体）。
戻り値 void

setAllowColumnResize

setAllowColumnResize(value: boolean): void

ドロップダウンリストの列幅をユーザーが変更できるかどうかを設定します。
参照：allowColumnResize

引数
- value: boolean
  
  列幅のリサイズを許可する場合はtrue、それ以外はfalse。
戻り値 void

setAllowDropDownResize

setAllowDropDownResize(value: boolean): void

ドロップダウンリストのリサイズを許可するかどうかを設定します。
参照：allowDropDownResize

引数
- value: boolean
  
  リストボックスのリサイズを許可するかどうか
戻り値 void

setAutoDropDown

setAutoDropDown(v: boolean): void

コントロールがフォーカスを取得すると、自動的にドロップダウンを開くかどうかを設定します。
参照：autoDropDown

引数
- v: boolean
  
  自動的にドロップダウンを開く場合はtrue、それ以外はfalse。
戻り値 void

setAutoFilter

setAutoFilter(type: AutoFilter): void

オートフィルターの種類を設定します。
参照：autoFilter

引数
- type: AutoFilter
  
  オートフィルターの種類
戻り値 void

setAutoScale

setAutoScale(value: boolean): void

テキストが入力幅から見きれてしまうときに、テキストを入力幅に合わせて縮小するかどうかを設定します。
参照：autoScale

引数
- value: boolean
  
  テキストが入力幅から見きれてしまうときに、テキストを入力幅に合わせて縮小するかどうかを表す値
戻り値 void

setAutoSelect

setAutoSelect(value: boolean): void

コンボボックスにテキストを入力したときに自動的にアイテムを選択するかどうかを設定します。
参照：autoSelect

引数
- value: boolean
  
  アイテムを自動的に選択するかどうか（true または false）
戻り値 void

setCheckedIndices

setCheckedIndices(indices: number[]): void

インデックスで指定したアイテムをチェックします。
参照：checkedIndices

引数
- indices: number[]
  
  チェックするインデックスの配列
戻り値 void

setCheckedItems

setCheckedItems(items: object[]): void

チェックするアイテムを設定します。
参照：checkedItems

引数
- items: object[]
  
  チェックするアイテムの配列
戻り値 void

setCheckedValues

setCheckedValues(values: number[] | string[] | boolean[] | object[]): void

valueMemberPathを使用してチェックするアイテムの値を設定します。
参照：checkedValues

引数
- values: number[] | string[] | boolean[] | object[]
  
  チェックするアイテムの値の配列
戻り値 void

setContainer

setContainer(el: HTMLElement): void

コントロールを配置しているコンテナを設定します。コントロールの下部にドロップダウンを表示するために十分なスペースがあるかどうかをチェックし、ドロップダウンを反転してコントロールの上部に表示するかどうかを決定します。
参照：container
```
combobox.setContainer(div);
```
引数
- el: HTMLElement
戻り値 void

setDropDownButtonVisible

setDropDownButtonVisible(value: boolean): void

ドロップダウンボタンを動的に表示または非表示にします。
参照：dropDownButtonVisible

引数
- value: boolean
  
  ドロップダウンボタンを表示する場合はtrue、非表示にする場合はfalse。
戻り値 void

setDropDownColumnWidth

setDropDownColumnWidth(col: string, width: number | string): void

ドロップダウンリストの特定の列の幅を設定します。

const gcComboBox = new GC.InputMan.GcComboBox(document.getElementById("combobox1"), {
    items: [
        {
            id: 1,
            name: 'Jenny'
        },
        {
            id: 2,
            name: 'Mike'
        }],
    columns: [
        {
            "name": "id",
            "width": 80,
        },
        {
            "name": "name",
            width: 200
        }],
    displayMemberPath: 'name',
    width: 200,
    height: 30,
    dropDownWidth: 300
});

// ドロップダウンリストの特定の列の幅を設定します。
gcComboBox.setDropDownColumnWidth('name', 120);

引数

col: string

列名
width: number | string

列幅

戻り値 void

setEditMode

setEditMode(v: EditMode): void

コントロールの編集モードを設定します。
参照：editMode

引数
- v: EditMode
  
  編集モードを示す値（EditMode列挙体）。
戻り値 void

setEditable

setEditable(value: boolean): void

コンボボックスのエディタを編集可能にするかどうかを設定します。
参照：editable

引数
- value: boolean
  
  編集可能にする場合はtrue、それ以外はfalse。
戻り値 void

setEllipsis

setEllipsis(v: EllipsisMode): void

文字列がコントロールの幅よりも長いときに、省略文字を表示するかどうかを設定します。
参照：ellipsis

引数
- v: EllipsisMode
  
  省略文字を表示方法を示す値（EllipsisMode列挙体）。
戻り値 void

setEllipsisString

setEllipsisString(v: string): void

コントロールに表示する省略文字を設定します。
参照：ellipsisString

引数
- v: string
  
  省略文字。
戻り値 void

setEnabled

setEnabled(v: boolean): void

コントロールやオブジェクトを有効にするかどうかを示す値を設定します。
参照：enabled

引数
- v: boolean
  
  有効にする場合はtrue、それ以外はfalse。
戻り値 void

setExitOnEnterKey

setExitOnEnterKey(v: ExitKey): void

フォーカスの移動方法を変更します。
参照：exitOnEnterKey

引数
- v: ExitKey
戻り値 void

setExitOnLeftRightKey

setExitOnLeftRightKey(v: ExitOnLeftRightKey): void

矢印キーを使ったフォーカスの移動方法を設定します。
参照：exitOnLeftRightKey

引数
- v: ExitOnLeftRightKey
  
  矢印キーを使ったフォーカスの移動方法を示す値（ExitOnLeftRightKey列挙体）。
戻り値 void

setHighlightText

setHighlightText(v: boolean): void

コントロールがフォーカスを受け取ったときに、テキストを選択するかどうかを設定します。
参照：highlightText

引数
- v: boolean
  
  選択状態を示す値（HighlightText列挙体）。
戻り値 void

setItems

setItems(items: object[]): void

ドロップダウンリストのアイテムを含む配列データを設定します。
参照：items

引数
- items: object[]
  
  アイテムの配列
戻り値 void

setMinScaleFactor

setMinScaleFactor(value: number): void

テキストを縮小するときの最小倍率を設定します。
参照：minScaleFactor

引数
- value: number
  
  最小倍率。
戻り値 void

setReadOnly

setReadOnly(value: boolean): void

コントロールを読み取り専用モードにするかどうかを設定します。
参照：readOnly

引数
- value: boolean
  
  読み取り専用の場合はtrue、それ以外はfalse。
戻り値 void

setSelectedIndex

setSelectedIndex(index: number): void

選択するアイテムのインデックスを設定します。
参照：selectedIndex

引数
- index: number
  
  選択するアイテムのインデックス
戻り値 void

setSelectedItem

setSelectedItem(item: object | string): void

選択するアイテムを設定します。
参照：selectedItem

引数
- item: object | string
  
  選択するアイテム
戻り値 void

setSelectedValue

setSelectedValue(value: number | string | boolean | object): void

valueMemberPathを使用して選択するアイテムの値を設定します。
参照：selectedValue

引数
- value: number | string | boolean | object
  
  選択するアイテムの値
戻り値 void

setShowClearButton

setShowClearButton(v: boolean): void

クリアボタンを表示するかどうかを設定します。
参照：showClearButton

引数
- v: boolean
  
  クリアボタンを表示するかどうかを表す値。
戻り値 void

setShowTip

setShowTip(value: boolean): void

セルの内容が見切れている場合に、すべてのセルのチップを表示するかどうかを設定します。
参照：showTip

引数
- value: boolean
  
  セルの内容が見切れている場合に、すべてのセルのチップを表示するかどうかを表す値。
戻り値 void

setSpinWheel

setSpinWheel(v: boolean): void

マウスホイールを使用してスピン動作を許可するかどうかを設定します。
参照：spinWheel

引数
- v: boolean
  
  マウスホイールを使用してスピン動作を許可するかどうかを表す値。
戻り値 void

setText

setText(text: string): void

コントロールにテキストを設定します。参照：text

引数
- text: string
  
  設定するテキスト
戻り値 void

setUseClipboard

setUseClipboard(v: boolean): void

クリップボードにアクセスすることを許可するかどうかを設定します。
参照：useClipboard

引数
- v: boolean
  
  アクセスを許可する場合はtrue、それ以外はfalse。
戻り値 void

setVisible

setVisible(v: boolean): void

コントロールをページに表示するかどうかを示す値を設定します。
参照：visible

引数
- v: boolean
  
  表示する場合はtrue、それ以外はfalse。
戻り値 void

setWatermarkDisplayNullText

setWatermarkDisplayNullText(v: string): void

コントロールにフォーカスがなく未入力のときの代替テキストを設定します。
参照：watermarkDisplayNullText

引数
- v: string
  
  代替テキスト。
戻り値 void

setWatermarkNullText

setWatermarkNullText(v: string): void

コントロールにフォーカスがあり未入力のときの代替テキストを設定します。
参照：watermarkNullText

引数
- v: string
  
  代替テキスト。
戻り値 void

sort

sort(sortInfo: SortInfo | SortFunc): void

指定した並び順でリロードします。 sortInfo が nullの場合、並び替えを解除します。

// 'id'列を昇順で並び替えます
combobox.sort({name: 'id', isAsc: true});

// 並び替えを解除します。
combobox.sort(null);

// 並び替え条件を関数で定義します。
combobox.sort(function (left, right) {
    return right.item.id - left.item.id;
});

引数

sortInfo: SortInfo | SortFunc

並び替えの条件を示します。

戻り値 void

updateColumnAutoFit

updateColumnAutoFit(config: AutofitInfo[]): void

指定された列の自動調整設定を更新します。

combobox.updateColumnAutoFit([
    {name: "id", autofit: true},
    {name: "name", autofit: true},
    {name: "age", autofit: false}
]);

引数

config: AutofitInfo[]

自動調整の設定方法を指定します。

戻り値 void

イベント

CheckedChanged

CheckedChanged(sender: GcComboBox): any

アイテムのチェック状態が変更されたときに発生します。

var checkedChangedHandler = function(sender){
    let checkedValues = sender.getCheckedValues();
    console.log(checkedValues);
}

// イベントリスナーを追加します。
combo.addEventListener(GC.InputMan.GcComboBoxEvent.CheckedChanged, checkedChangedHandler);

// イベントリスナーを削除します。
combo.removeEventListener(GC.InputMan.GcComboBoxEvent.CheckedChanged, checkedChangedHandler);

引数

sender: GcComboBox

イベントが発生したコントロールのオブジェクト

戻り値 any

DropDownClosed

DropDownClosed(sender: GcComboBox): any

ドロップダウンリストが閉じられたときに発生します。

var dropDownClosedHandler = function(sender){
    console.log("DropDownClosed");
}

// イベントリスナーを追加します。
combo.addEventListener(GC.InputMan.GcComboBoxEvent.DropDownClosed, dropDownClosedHandler);

// イベントリスナーを削除します。
combo.removeEventListener(GC.InputMan.GcComboBoxEvent.DropDownClosed, dropDownClosedHandler);

引数

sender: GcComboBox

イベントが発生したコントロールのオブジェクト

戻り値 any

DropDownOpened

DropDownOpened(sender: GcComboBox): any

ドロップダウンリストが開いたときに発生します。

var dropDownOpenedHandler = function(sender){
    console.log("DropDownOpened");
}

// イベントリスナーを追加します。
combo.addEventListener(GC.InputMan.GcComboBoxEvent.DropDownOpened, dropDownOpenedHandler);

// イベントリスナーを削除します。
combo.removeEventListener(GC.InputMan.GcComboBoxEvent.DropDownOpened, dropDownOpenedHandler);

引数

sender: GcComboBox

イベントが発生したコントロールのオブジェクト

戻り値 any

ItemsChanged

ItemsChanged(sender: GcComboBox): any

アイテムのリストが変更されたときに発生します。

var itemsChangedHandler = function(sender){
    console.log("ItemsChanged");
}

// イベントリスナーを追加します。
combo.addEventListener(GC.InputMan.GcComboBoxEvent.ItemsChanged, itemsChangedHandler);

// イベントリスナーを削除します。
combo.removeEventListener(GC.InputMan.GcComboBoxEvent.ItemsChanged, itemsChangedHandler);

引数

sender: GcComboBox

イベントが発生したコントロールのオブジェクト

戻り値 any

SelectedChanged

SelectedChanged(sender: GcComboBox): any

選択しているアイテムが変更されたときに発生します。

var selectedChangedHandler = function(sender){
    let selectedValue = sender.getSelectedValue();
    console.log(selectedValues);
}

// イベントリスナーを追加します。
combo.addEventListener(GC.InputMan.GcComboBoxEvent.SelectedChanged, selectedChangedHandler);

// イベントリスナーを削除します。
combo.removeEventListener(GC.InputMan.GcComboBoxEvent.SelectedChanged, selectedChangedHandler);

引数

sender: GcComboBox

イベントが発生したコントロールのオブジェクト

戻り値 any

SpinDown

SpinDown(sender: GcComboBox): any

スピンダウンボタンがクリックされたときに発生します。

var spinDownHandler = function(sender){
    console.log("SpinDown");
}

// イベントリスナーを追加します。
combo.addEventListener(GC.InputMan.GcComboBoxEvent.SpinDown, spinDownHandler);

// イベントリスナーを削除します。
combo.removeEventListener(GC.InputMan.GcComboBoxEvent.SpinDown, spinDownHandler);

引数

sender: GcComboBox

イベントが発生したコントロールのオブジェクト

戻り値 any

SpinUp

SpinUp(sender: GcComboBox): any

スピンアップボタンがクリックされたときに発生します。

var spinUpHandler = function(sender){
    console.log("SpinUp");
}

// イベントリスナーを追加します。
combo.addEventListener(GC.InputMan.GcComboBoxEvent.SpinUp, spinUpHandler);

// イベントリスナーを削除します。
combo.removeEventListener(GC.InputMan.GcComboBoxEvent.SpinUp, spinUpHandler);

引数

sender: GcComboBox

イベントが発生したコントロールのオブジェクト

戻り値 any

TextChanged

TextChanged(sender: GcComboBox): any

テキストが変更され、コントロールがフォーカスを失ったときに発生します。

var textChangedChangedHandler = function(sender){
    let text = sender.getDisplayText();
    console.log(text);
}

// イベントリスナーを追加します。
combo.addEventListener(GC.InputMan.GcComboBoxEvent.TextChanged, textChangedChangedHandler);

// イベントリスナーを削除します。
combo.removeEventListener(GC.InputMan.GcComboBoxEvent.TextChanged, textChangedChangedHandler);

引数

sender: GcComboBox

イベントが発生したコントロールのオブジェクト

Inputman.GcComboBox

GcComboBox クラス

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

引数

ele: HTMLSelectElement

オプション option: ComboBoxConfig

戻り値 GcComboBox

プロパティ

acceptsCrlf

allowColumnResize

allowDropDownResize

autoCompleteMatchMode

autoCompleteMode

autoDropDown

autoFilter

autoScale

autoSelect

checkedIndices

checkedItems

checkedValues

読み取り専用 componentName

container

copiedMessage

copyMessage

読み取り専用 displayMemberPath

読み取り専用 displayText

dropDownButtonVisible

読み取り専用 dropDownTree

読み取り専用 dropDownType

読み取り専用 dropDownWindow

editMode

editable

ellipsis

ellipsisString

enabled

exitOnEnterKey

exitOnLeftRightKey

floatingLabelDirection

floatingLabelText

floatingLabelType

fontSize

height

helpContent

highlightText

読み取り専用 isOverwrite

items

maxHeight

maxWidth

minHeight

minScaleFactor

minWidth

multipleItemSeparator

readOnly

selectedIndex

selectedItem

selectedValue

showClearButton

showCopyButton

showHelpButton

showTip

spinButton

spinWheel

tabIndex

text

useClipboard

読み取り専用 valueMemberPath

visible

watermarkDisplayNullText

watermarkNullText

width

メソッド

addEventListener

引数

eventType: GcComboBoxEvent