Documents Client SDK

Class: GentableGridColumnModel

documents.sdk.gentable.grid GentableGridColumnModel

Constructors

Extends

Methods

getButtonLabel(){String}

Returns the button label of the current column.

  • Since:
    • 5.0c HF1
Returns:
Type Description
String the button label of the current column
Example
documents.sdk.gentable.gentableRegistry.registerCallback("*", "Gentable.afterRender", function(documentsContext, options) {
	documentsContext.getGentableContext().getGridModel().getColumn("unitprice").getButtonLabel();
}

getDataType(){String}

Returns the data type of the current column.

  • Since:
    • 5.0a
Returns:
Type Description
String the data type of the current column
Example
documents.sdk.gentable.gentableRegistry.registerCallback("*", "Gentable.afterRender", function(documentsContext, options) {
	documentsContext.getGentableContext().getGridModel().getColumn("unitprice").getDataType(); //NUMBER
}

getDecimalPlaces(){Number}

Returns the number of decimal places of the current column.

  • Since:
    • 5.0c HF1
Returns:
Type Description
Number the number of decimal places of the current column
Example
documents.sdk.gentable.gentableRegistry.registerCallback("*", "Gentable.afterRender", function(documentsContext, options) {
	documentsContext.getGentableContext().getGridModel().getColumn("unitprice").getDecimalPlaces(); //2
}

getLabel(){String}

Returns the localized label of the current column.

  • Since:
    • 5.0a
Returns:
Type Description
String the localized label of the current column
Example
documents.sdk.gentable.gentableRegistry.registerCallback("*", "Gentable.afterRender", function(documentsContext, options) {
	documentsContext.getGentableContext().getGridModel().getColumn("unitprice").getLabel(); //unit price
}

getName(){String}

Returns the key of the current column.

  • Since:
    • 5.0a
Returns:
Type Description
String the key of the current column
Example
documents.sdk.gentable.gentableRegistry.registerCallback("*", "Gentable.afterRender", function(documentsContext, options) {
	documentsContext.getGentableContext().getGridModel().getColumn("unitprice").getName(); //unitprice
}

getNumberFormat(){String}

Returns the number format of the current column.

  • Since:
    • 5.0c HF1
Returns:
Type Description
String the number format of the current column
Example
documents.sdk.gentable.gentableRegistry.registerCallback("*", "Gentable.afterRender", function(documentsContext, options) {
	documentsContext.getGentableContext().getGridModel().getColumn("unitprice").getNumberFormat(); //n.2
}

getTooltip(){String}

Returns the tooltip of the current column.

  • Since:
    • 5.0c HF1
Returns:
Type Description
String the tooltip of the current column
Example
documents.sdk.gentable.gentableRegistry.registerCallback("*", "Gentable.afterRender", function(documentsContext, options) {
	documentsContext.getGentableContext().getGridModel().getColumn("unitprice").getTooltip(); //unit price
}

isEditable(){Boolean}

Checks if the current column is editable.

  • Since:
    • 5.0a
Returns:
Type Description
Boolean true if the column is editable, false otherwise
Example
documents.sdk.gentable.gentableRegistry.registerCallback("*", "Gentable.afterRender", function(documentsContext, options) {
	documentsContext.getGentableContext().getGridModel().getColumn("unitprice").isEditable(); //false
}

isFocusable(){Boolean}

Checks if the current column is focusable.

  • Since:
    • 5.0c HF1
Returns:
Type Description
Boolean true if the column is focusable, false otherwise
Example
documents.sdk.gentable.gentableRegistry.registerCallback("*", "Gentable.afterRender", function(documentsContext, options) {
	documentsContext.getGentableContext().getGridModel().getColumn("unitprice").isFocusable(); //false
}

isVisible(){Boolean}

Checks if the current column is visible.

  • Since:
    • 5.0a
Returns:
Type Description
Boolean true if the column is visible, false otherwise
Example
documents.sdk.gentable.gentableRegistry.registerCallback("*", "Gentable.afterRender", function(documentsContext, options) {
	documentsContext.getGentableContext().getGridModel().getColumn("unitprice").isVisible(); //true
}