Gui.Form.GsGridControl.GetColumnProperty

From GAB Help
Jump to: navigation, search

This method gets the value of a specific property for column.


Syntax

Gui.Form.GsGridControlName.GetColumnProperty(GridviewName [string], ColumnName [string], PropertyName [string], Return value [string])

Arguments

GridviewName

Name of gridview

ColumnName

Name of column

PropertyName

Name of property

ReturnValue

Returned value of property

Examples

Gui.Form.GsGridControlName.GetColumnProperty("Gridview1", "Column1", "HeaderBackColor", V.Local.sRet)


Properties

  • Most features are using boolean as argument, otherwise stated.

Currently available properties:

1.HeaderBackColor

Change color of header’s background


2.HeaderForeColor

Change color of header’s texts


4.HeaderFontName

Change header’s text fontstyle name


5.HeaderFontSize

Change header’s text size


6.HeaderFontBold

Change header’s textstyle boldness


7.HeaderFontItalic

Change header’s italic textstyle


8.HeaderFontStrikeOut

Change header’s text striked out style


9.HeaderFontUnderline

Change header’s text style of underlining.


10.HeaderImage (Not available for Get command)

Display an image for Header’s cell. This uses a file path to [get/use] the image to display on header cell.


11.HeaderHAlignment

Adjust the horizontal alignment for text in header cell. Acceptable values are: far, center, near, default.


12.HeaderHotkeyPrefix

In a graphical user interface, the hot key is an underlined letter in a word (usually combined with another key, such as the Alt key) that you can press on the keyboard to activate the functionality that the word represents.

This property sets the hot key prefix for text in header cell. Acceptable values are: none/show/hide/default.


13.HeaderTrimming

The Trimming property specifies how the characters in a string that does not completely fit into a layout shape are trimmed. Acceptable values are: default, none, character, word, Ellipsis Character, ElissisWord, Ellipsis Path


14.HeaderVAlignment

Adjust the vertical alignment for text in header cell. Acceptable values are: top, center, bottom, default.


15.HeaderWordWrap

Do word wrapping for texts in header cell. Acceptable values are: default, wrap, nowrap.

When setting column headers’ word-wrapping, please also increase the column headers’ height by setting Gridview’s ColumnPanelRowHeight to an appropriate height to accomodate length of wrapped headers’ values.


16.CellBackColor

Change color of cell’s background


17.CellForeColor

Change color of cell’s texts


19.CellFontName

Change cell’s text fontstyle name


20.CellFontSize

Change cell’s text size


21.CellFontBold

Change cell’s textstyle boldness


22.CellFontItalic

Change cell’s italic textstyle


23.CellFontStrikeOut

Change cell’s text striked out style


24.CellFontUnderline

Change cell’s text style of underlining.


25.CellImage (Not available for Get command)

Display an image for cell. This uses a file path to [get/use] the image to display on cell.


26.CellHAlignment

Adjust the horizontal alignment for text in cell. Acceptable values are: far, center, near, default.


27.CellHotkeyPrefix

In a graphical user interface, the hot key is an underlined letter in a word (usually combined with another key, such as the Alt key) that you can press on the keyboard to activate the functionality that the word represents.

This property sets the hot key prefix for text in cell. Acceptable values are: none/show/hide.


28.CellTrimming

The Trimming property specifies how the characters in a string that does not completely fit into a layout shape are trimmed. Acceptable values are: default, none, character, word, Ellipsis Character, ElissisWord, Ellipsis Path


29.CellVAlignment

Adjust the vertical alignment for text in cell. Acceptable values are: top, center, bottom, default.


30.CellWordWrap

Do word wrapping for texts in cell. Acceptable values are: default, wrap, nowrap.

When setting column cells’ word-wrapping, please also increase rows’ height by setting Gridview’s OptionsViewRowAutoHeightto to True to accomodate length of wrapping values.


31.Image (Not available for Get command)

set an image displayed within the Column Header.

This uses a file path to [get/use] the image to display.


32.ImageAlignment

set the column header image alignment.

Acceptable values are: center, near, far


33.ImageIndex

set the index of the image displayed within the column header.


'-------General column property-------

34.Visible

set whether the column is visible.


35.ReadOnly

Set a value indicating whether the column’s ReadOnly option is enabled, or whether end-users are prevented from editing the column's cell values.


36.MaxWidth

Set a value indicating the column's maximum width.


37.MinWidth

Set a value indicating the column's minimum width.


38.Width

Set a value indicating the column's width.


39.ShowButtonMode

specifies which cells display editor buttons. The column's ShowButtonMode property should be used to override these settings for individual columns.

Acceptable mode are: ShowAlways, ShowForFocusedRow, ShowForFocusedCell, ShowOnlyInEditor


40.ToolTip

sets a custom tooltip for the column.


41.VisibleIndex

sets the column's visible state and position within the View. If you need to make a column invisible, please use ‘Visible’ property.


42.Fixed

sets a value specifying whether the column takes part in horizontal View scrolling or is anchored to a View edge.

Acceptable mode are: left, none, right


------OptionsColumn--------

43.AllowEdit

Determine whether end-users are allowed to invoke editors for the column's cells. AllowEdit is set through this command, or set with the its gridview’s Editable mode. This option allows column cells’ values to be selected/highlighted.


Note: To enable column data editing, please set ReadOnly to False.


44.AllowFocus

Determine whether a Column can be set on focus.


45.AllowGroup

Determine whether a Column can be grouped.

Acceptable values are: true, false, default.


46.AllowIncrementalSearch

Determine whether to search all or search from the cursor point.


47.AllowMerge

Determine whether a Column can be merged.

Acceptable values are: true, false, default.


48.AllowMove

Determine whether a Column can be moved around.


49.AllowShowHide

Determine whether a Column is shown or hidden.


50.AllowSize

Determine whether a Column’s size can be adjusted.


51.AllowSort

Determine whether column’s sorting is allowed.

Acceptable values are: true, false, default.


52.FixedWidth

Determine whether column’s width is adjustable.


53.Printable 'As Boolean

Determine whether column’s data can be printed.

Acceptable values are: true, false, default.


54.ShowCaption

Determine whether column’s caption is shown.


55.TabStop

Determine whether the column can be focused via the TAB key.

If the TabStop property is set to false, the column's cells cannot be focused when navigating through cells via the TAB key. However, these cells can still be focused via the mouse or navigating through cells via the ARROW keys.


------OptionsFilter--------

56.AllowAutoFilter

Determine whether column’s auto filter mode to be on or off.


57.AllowFilter

Determine whether column’s filter mode to be on or off.


58.ImmediateUpdateAutoFilter

Determine whether column should update immediately after filtered.


59.ImmediateUpdatePopupDateFilterOnCheck

Determine a value that specifies whether data is filtered immediately, when toggling the check boxes in the filter dropdown.

This option is in effect for date-time columns whose filter dropdown list contains an embedded calendar with check boxes to select common date intervals. It specifies whether toggling the check boxes filters grid records immediately.

Acceptable values are: true, false, default.


60.ImmediateUpdatePopupDateFilterOnDateChange

Determine a value that specifies whether data is filtered immediately, when selecting a date or date range via the calendar.

This option is in effect for date-time columns whose filter dropdown list contains an embedded calendar with check boxes to select common date intervals. It specifies whether selecting a date or date range via the embedded calendar filters grid records immediately.

Acceptable values are: true, false, default.


61.ShowBlanksFilterItems

Determine a value that specifies whether the column's Filter Dropdown (when presented as a Regular List or Checked List) displays the "(Blanks)" and "(Non Blanks)" filter items.

Acceptable values are: true, false, default.


62.ShowEmptyDateFilter

Determine whether a Filter Dropdown List has a filter used to select records that contain null values in a date-time column.


63.Caption

Changes Header column's caption.


64.DisplayFormatType

Gets or sets the type of formatting specified by the current FormatInfo object.

a.Case "numeric"

b.Case "datetime"

c.Case "none"


65.DisplayCustomNumeric

This specifies the type of numeric values to be formatted.


66.DisplayCustomDatetime

This specifies the type of date time values to be formatted.

http://gabforums.globalshopsolutions.com/topic.asp?TOPIC_ID=16387

Format Specifier - Description - Sample Output

d - Short date pattern - 3/12/2003

D - Long date pattern - Wednesday, March 12, 2003

t - Short time pattern - 12:00 AM

T - Long time pattern - 12:00:00 AM

f - Full date/time pattern (short time) - Wednesday, March 12, 2003 12:00 AM

F - Full date/time pattern (full time) - Wednesday, March 12, 2003 12:00:00 AM

g - General date/time pattern (short time) - 3/12/2003 12:00 AM

G - General date/time pattern (full time) - 3/12/2003 12:00:00 AM


67.DisplayCustomString

This specifies the type of string values to be formatted.


68.Icon

a.^

b.DCS-ON

c.DCS-OFF

d.BROWSE

e.REFRESH


69. EditMask

This specifies the string that sets a mask expression. Masks should be constructed according to the mask type specified by the MaskType property.


70. EditMaskType

This sets the mask type. The mask expression should be constructed using the syntax that is determined by the mask type. Use the EditMask property to specify the mask expression. Valid string formats: DateTime, DateTimeAdvancingCaret, None, Numeric, RegEx


71. EditMaskAsDisplayFormat

This property sets whether display values are still formatted using the mask when the editor is not focused.

Example

Gui.Form1.GsGCTest.SetColumnProperty("Gridview1", "RunnerSpeed", "EditMaskType", "numeric")
Gui.Form1.GsGCTest.SetColumnProperty("Gridview1", "RunnerSpeed", "EditMask", "0000000")
Gui.Form1.GsGCTest.SetColumnProperty("Gridview1", "RunnerSpeed", "EditMaskAsDisplayFormat", true)


72. ProgressBarEnabled

This enables the progress bar to be displayed. True to turn it on and False to turn it off.


73. ProgressBarMinimum

This sets the control's maximum value.


74. ProgressBarMaximum

This sets the control's minimum value.


75. ProgressBarShowTitle

This sets whether the text that represents the progress bar's current position is displayed. True to turn it on and False to turn it off.


76. ProgressBarPercentView

This sets a value specifying how the text representing the progress bar's current position is displayed. True to turn it on and False to turn it off.


77. ProgressBarStartColor

This property sets the indicator's starting color.


78. ProgressBarEndColor

This property sets the indicator's end color.


Example

Gui.Form1.GsGCTest.SetColumnProperty("gridview1", "RunnerSpeed", "ProgressBarEnabled", true)
Gui.Form1.GsGCTest.SetColumnProperty("gridview1", "RunnerSpeed", "ProgressBarMinimum", 0)
Gui.Form1.GsGCTest.SetColumnProperty("gridview1", "RunnerSpeed", "ProgressBarMaximum", 10)
Gui.Form1.GsGCTest.SetColumnProperty("gridview1", "RunnerSpeed", "ProgressBarStartColor", "purple")
Gui.Form1.GsGCTest.SetColumnProperty("gridview1", "RunnerSpeed", "ProgressBarEndColor", "limegreen")
Gui.Form1.GsGCTest.SetColumnProperty("gridview1", "RunnerSpeed", "ProgressBarPercentView", true)
Gui.Form1.GsGCTest.SetColumnProperty("gridview1", "RunnerSpeed", "ProgressBarShowTitle", true)


Remarks