Multi Theft Auto: Wiki - User contributions [en]

Dgs-dxmemo

2026-04-11T20:35:26Z

Zhvachka:

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxmemo that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===allowCopy===
This property determines whether the content of memo can be copy(ctrl+c)/cut(ctrl+x)
<syntaxhighlight lang="lua">dgsSetProperty(memo,"allowCopy",allowCopy)</syntaxhighlight>
*'''allowCopy:''' A boolean value of the state of whether this memo allows users to copy something from it.

===bgColor===
This property determines the background color of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor:''' An integer of the color that can be converted by [[tocolor]].

===bgColorBlur===
This property determines the background color of the memo when it is blurred.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"bgColorBlur",bgColorBlur)</syntaxhighlight>
*'''bgColorBlur:''' An integer of the color that can be converted by [[tocolor]], leave to nil to use bgColor.

===bgImage===
This property determines the background image of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage:''' A material element that serves as the background image of the memo (texture/shader/screen source/renderTarget).

===bgImageBlur===
This property determines the background image of the memo when it is blurred.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"bgImageBlur",bgImageBlur)</syntaxhighlight>
*'''bgImageBlur:''' A material element that serves as the background image of the memo (texture/shader/screen source/renderTarget), leave to nil to use bgImage.

===caretColor===
This property determines the color of the caret
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretColor",caretColor)</syntaxhighlight>
*'''caretColor:''' An integer of the color that can be converted by [[tocolor]].

===caretHeight===
The height of the caret of the memo (multiple of the font height).
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretHeight",caretHeight)</syntaxhighlight>
*'''caretHeight:''' A float of the caret height.

===caretOffset===
The offset of the caret of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretOffset",offsetY)</syntaxhighlight>
*'''offsetY:''' A float of the 2D Y position offset of the caret of the memo.

===caretPos===
The position in which the caret stays.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretPos",{index,line})</syntaxhighlight>
*'''index:''' An integer of the index of the text in current line of the memo.
*'''line:''' An integer of the line of the memo.

===caretStyle===
This is equivalent to [[dgsMemoSetCaretStyle]]/[[dgsMemoGetCaretStyle]].

This property allows us to change the style of caret of the memo. ( 0 is "|"; 1 is "_" )

Example(0):

This is Text|

Example(1):

This is Text_
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretStyle",caretStyle)</syntaxhighlight>
*'''caretStyle:''' An integer of the caret style of the memo.

===caretThick===
This property allows us to change the thickness of caret of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretThick",caretThick)</syntaxhighlight>
*'''caretThick:''' An integer of the thickness of the caret of the memo.

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(memo,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(memo,"font",font)</syntaxhighlight>
*'''font:''' A [[Element/DX_font|dx font element]] of the text font of the memo.

===padding===
This property determines the content padding from 4 sides of element (left/top/right/bottom)
<syntaxhighlight lang="lua">dgsSetProperty(memo,"padding", {horizontal, vertical})</syntaxhighlight>
*'''horizontal:''' A float of the horizontal padding in pixels.
*'''vertical:''' A float of the vertical padding in pixels.

===placeHolder===
This is equivalent to [[dgsEditSetPlaceHolder]]//[[dgsEditGetPlaceHolder]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolder",placeHolder)</syntaxhighlight>
*'''placeHolder''' : A string of the place holder text of dgs edit ( This text will show when there is no text in a blurred dgs edit ).

===placeHolderColor===
This property determines the color of the place holder text. The color which can be translated by [[tocolor]].
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderColor",placeHolderColor)</syntaxhighlight>
*'''placeHolderColor''' : An integer of the color of the place holder text of the edit.

===placeHolderColorcoded===
This property determines whether the place holder supports color code.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderColorcoded",placeHolderColorcoded)</syntaxhighlight>
*'''placeHolderColorcoded''' : A bool indicates whether the place holder supports color code.

===placeHolderFont===
This property changes the font of place holder.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderFont",placeHolderFont)</syntaxhighlight>
*'''placeHolderFont''' : A string/dx-font element of the font of the place holder.

===placeHolderIgnoreRenderTarget===
This property determines whether the place holder isn't restricted by render target.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderIgnoreRenderTarget",placeHolderIgnoreRenderTarget)</syntaxhighlight>
*'''placeHolderIgnoreRenderTarget''' : A bool indicates whether the place holder isn't restricted by render target.

===placeHolderOffset===
This property allows place holder has offsets relative to its original position.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderOffset",{ xOffset, yOffset })</syntaxhighlight>
*'''xOffset''' : An integer of 2D x offset.
*'''yOffset''' : An integer of 2D y offset.

===placeHolderVisibleWhenFocus===
This property allows place holder to be visible even when edit is focused.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderVisibleWhenFocus",placeHolderVisibleWhenFocus)</syntaxhighlight>
*'''placeHolderVisibleWhenFocus''' : A bool indicates whether the place holder when the edit is focused.

===readOnly===
This is equivalent to [[dgsMemoSetReadOnly]]/[[dgsMemoGetReadOnly]].
<syntaxhighlight lang="lua">dgsSetProperty(memo,"readOnly",readOnly)</syntaxhighlight>
*'''readOnly:''' A bool indicates whether the memo is only readable.

===readOnlyCaretShow===
Whether the caret of memo will show/hide under read-only mode.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"readOnlyCaretShow",readOnlyCaretShow)</syntaxhighlight>
*'''readOnlyCaretShow:''' A bool indicates whether the caret is shown or hidden when the memo is read-only.

===renderTarget===
This property stores a render target of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"renderTarget",renderTarget)</syntaxhighlight>
*'''renderTarget:''' A render target that is used to render the text.

===scrollbars===
This property stores two scroll bars which can be got by [[dgsMemoGetScrollBar]] of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"scrollbars",{Vertical,Horizontal})</syntaxhighlight>
*'''Vertical:''' A vertical scroll bar of the memo.
*'''Horizontal:''' A horizontal scroll bar of the memo.

===scrollBarThick===
This property allows us to change the thickness of scroll bars of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"scrollBarThick",scrollBarThick)</syntaxhighlight>
*'''scrollBarThick:''' An integer of the thickness of scroll bars of the memo.

===scrollSize===
This property determines how many lines will get scrolled out of the rendering area once when you are scrolling your mouse wheel.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"scrollSize",scrollSize)</syntaxhighlight>
*'''scrollSize:''' Lines to be scrolled.

===selectColorBlur===
The color which can be translated by [[tocolor]] of the rectangle of text selection of the memo when blurred.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"selectColorBlur",selectColorBlur)</syntaxhighlight>
*'''selectColorBlur:''' An integer of the color of the rectangle of text selection of the memo when blurred.

===selectColor===
The color which can be translated by [[tocolor]] of the rectangle of text selection of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"selectColor",selectColor)</syntaxhighlight>
*'''selectColor:''' An integer of the color of the rectangle of text selection of the memo.

===selectFrom===
The position from which the text is selected.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"selectFrom",{index,line})</syntaxhighlight>
*'''index:''' An integer of the index of the text in the line where the text is selected from of the memo.
*'''line:''' An integer of the line where the text is selected from of the memo.

===shadow===
The shadow text of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the memo.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the memo.
*'''color:''' An integer of the color of the shadow text of the memo.
*'''outline:''' An integer of the outline style of the shadow text.

===showLine===
This property stores the value of how many lines does the text move to top.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"showLine",line)</syntaxhighlight>
*'''line:''' An integer indicates how many lines does the text move to top.

===showPos===
This property stores the value of how many pixels of the text are moved to left.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"showPos",posX)</syntaxhighlight>
*'''posX:''' An integer indicates how many pixels of the text are moved to left.

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(memo,"text",text)</syntaxhighlight>
*'''text:''' A ''table'' of the text of the memo.( Because of multi lines, I use table instead of string )

===textColor===
The color which can be translated by [[tocolor]] of the text of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the memo.

===textLength===
This is for scroll bar detection. You had better not touch it.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"textLength",textlen)</syntaxhighlight>
*'''textlen:''' A table stores the length of text in every line.

===textSize===
The scale of the text of the memo. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(memo,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the memo.
*'''scaleY:''' A float of the 2D Y scale of the text of the memo.

===typingSound===
Typing sound, nil for disabled. This is equivalent to [[dgsMemoSetTypingSound]]/[[dgsMemoGetTypingSound]]
<syntaxhighlight lang="lua">dgsSetProperty(memo,"typingSound",typingSound)</syntaxhighlight>
*'''typingSound:''' A string of the path/url of typing sound.

===typingSoundVolume===
Typing sound, nil for disabled. This is equivalent to [[dgsMemoSetTypingSoundVolume]]/[[dgsMemoGetTypingSoundVolume]]
<syntaxhighlight lang="lua">dgsSetProperty(memo,"typingSoundVolume",typingSoundVolume)</syntaxhighlight>
*'''typingSoundVolume:''' A float of the volume of the typing sound. Range is from 0.0 to 1.0. This can go above 1.0 for amplification.

===wordWrap===
This property determines the word wrap state of dgs memo. This is equivalent to [[dgsMemoSetWordWrapState]]/[[dgsMemoGetWordWrapState]]
<syntaxhighlight lang="lua">dgsSetProperty(memo,"wordWrap",wordWrap)</syntaxhighlight>
*'''wordWarp:''' An integer or a bool of word wrap state, vaild state are as follows:
**'''false:''' Non-wordwrap
**'''1:''' Split via single character ( This will break a word into 2 parts )
**'''2:''' Split via word

==See Also==
{{DGSPROPERTIES}}

DgsCreateLine

2022-04-23T17:24:56Z

Zhvachka: /* Syntax */

__NOTOC__
{{Client function}}
This function creates a DGS Line on the screen.

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateLine ( float x, float y, float w, float h, bool relative [, element parent = nil, float lineWidth = 1, int color = 0xFFFFFFFF ])
</syntaxhighlight>
[[Image:DGS_Line.png|300px|thumb|right|]]

===Required Arguments===
*'''x:''' A float of the 2D x position of the line on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the line on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the line. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the line. This is affected by the ''relative'' argument.
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all ''x, y, width'' and ''height'' floats must be between 0 and 1, representing sizes relative to the parent.

===Optional Arguments===
*'''parent:''' This is the parent that the DGS Line is attached to.
*'''lineWidth:''' A float of the default width of DGS Line.
*'''color:''' An integer of the default color of DGS Line.

===Returns===
Returns a DGS Line if it was successfully created, false otherwise.

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs

local line = DGS:dgsCreateLine(400,200,600,400)
local sinX = math.sin(0/500*4*math.pi)
DGS:dgsLineAddItem(line,0/500,sinX/2+0.5,0/500,sinX/2+0.5,2,tocolor(0,255,0,255),true)
for i=1,100 do
local sinX = math.sin(i/100*4*math.pi)
DGS:dgsLineAddItem(line,_,_,i/100,sinX/2+0.5,2,tocolor(i/100*255,255-i/100*255,0,255),true)
end
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

Dgs-dxlabel

2022-03-31T10:50:40Z

Zhvachka: /* colorcCoded */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxlabel that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the text within the label.

The functions as follows are based on this property.

[[dgsLabelSetHorizontalAlign]]/[[dgsLabelGetHorizontalAlign]]

[[dgsLabelSetVerticalAlign]]/[[dgsLabelGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(label,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the label. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the label. Can be "top", "center" or "bottom".

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(label,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(label,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(label,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the label.

===shadow===
The shadow text of the label.
<syntaxhighlight lang="lua">dgsSetProperty(label,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the label.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the label.
*'''color:''' An integer of the color of the shadow text of the label.
*'''outline:''' A bool of the outline state of the shadow text.

===subPixelPositioning===
This property determines whether the '''subPixelPositioning''' is enabled or not, by default, it is disable. ''Learn More [[dxDrawText]]''

'''subPixelPositioning''' Will make positioning and resizing animation looks better, but you should know, it may blur your static text with unrounded position and size, or alignment.

If you are using dgs animation library, you'd better turn this on.
<syntaxhighlight lang="lua">dgsSetProperty(label,"subPixelPositioning",subPixelPositioning)</syntaxhighlight>
*'''subPixelPositioning:''' A bool indicates whether to enable subPixelPositioning or not.

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(label,"text",text)</syntaxhighlight>
*'''text:''' A string of the text of the label.

===textColor===
The color which can be translated by [[tocolor]] of the text of the label.
<syntaxhighlight lang="lua">dgsSetProperty(label,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the label.

===textOffset===
The offset of the text on label.
<syntaxhighlight lang="lua">dgsSetProperty(label,"textOffset",{offsetX,offsetY,relative})</syntaxhighlight>
*'''offsetX''' : A float of the 2D X offset relative to the position of the label, depends on '''relative'''.
*'''offsetY''' : A float of the 2D Y offset relative to the position of the label, depends on '''relative'''.
*'''relative''' : A bool of whether the offset is relative or absolute.

===textSize===
The scale of the text of the label. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(label,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the label.
*'''scaleY:''' A float of the 2D Y scale of the text of the label.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(label,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==See Also==
{{DGSPROPERTIES}}

DGS General Basic Properties

2022-03-27T15:42:47Z

Zhvachka: /* hitoutofparent */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the general properties of all dgs elements that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alpha===
Require a number ranges from 0 to 1. This is equivalent to [[dgsSetAlpha]]/[[dgsGetAlpha]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"alpha",alpha = 1)</syntaxhighlight>
*'''alpha:''' The visibility/transparency of the DGS element. Ranges from 0 (fully transparent) to 1 (fully opaque). Default value is 0.80.

===clickCoolDown===
This property is used to limit the click frequency to a specific dgs element
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"clickCoolDown",clickCoolDown = false)</syntaxhighlight>
*'''clickCoolDown:''' A number indicates how long you want to limit the click (ms).

===changeOrder===
Require a bool indicates whether the layer will be changed when being brought to front ( or clicked ).
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"changeOrder",changeOrder = true)</syntaxhighlight>
*'''changeOrder:''' A bool indicates whether the layer will be changed when being brought to front ( or clicked ).

===debugTrace===
This property stores the "debug tracing data" includes in which lua '''file''' and '''line''' the specific dgs element created (Only available using '''loadstring(exports.dgs:dgsImportFunction())()'''.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"debugTrace",debugTrace)</syntaxhighlight>
*'''debugTrace:''' A table stores creation data. Structure is as follows:
<syntaxhighlight lang="lua">
{
file=filePath,
line=lineNum,
fncName=functionName,
}
</syntaxhighlight>

===enabled===
Requires a bool value. This is equivalent to [[dgsSetEnabled]]/[[dgsGetEnabled]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"enabled",alpha = true)</syntaxhighlight>
*'''enabled:''' The state.

===functionRunBefore===
Requires a bool value. Set whether the function runs before rendering or after rendering (see property '''functions''').
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"functionRunBefore",functionRunBefore = true)</syntaxhighlight>
*'''functionRunBefore:''' Set to true, and the function will run before rendering. Set to false, and the function will run after rendering.

===functions===
Requires a string at the 3rd argument. This property runs a function while rendering.

'''Predefine Variable'''
*'''self:''' The DGS Element itself.

See example in [[dgsSetProperty]]
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"functions",fncString,arg1,arg2,...)</syntaxhighlight>
*'''fncString:''' The string of function to be loaded.
*'''arg1:''' argument 1
*'''arg2:''' argument 2
*'''...:''' other arguments

===childOutsideHit===
Requires a bool value. Set whether children elements are clickable when they are outside of their parent element.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"childOutsideHit",childOutsideHit = false)</syntaxhighlight>
*'''childOutsideHit:''' If set to true, the dgsElement's child elements are clickable even though they are not inside the bounding box of dgsElement.

===ignoreParentTitle===
Requires a bool value. Set whether to ignore the title of dgs-dxwindow.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"ignoreParentTitle",ignoreParentTitle = false)</syntaxhighlight>
*'''ignoreParentTitle:''' Set to true to ignore the title of dgs-dxwindow if its parent is a dgs-dxwindow . Set to false to disable it, which means the y position of dgsElement in dgs-dxwindow will start to be calculated under the title.

===outline===
The border line of the bounding box of dgs element.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"outline",{side,width,color,left,right,top,bottom})</syntaxhighlight>
*'''side''' : A string indicates which side the outline will attach to. The available values are as follows:
**'''in'''
**'''center'''
**'''out'''
*'''width''': The width of the outline.
*'''color''': The color of the outline, which can be transformed by [[tocolor]].
*'''left''': Set '''true''' to show outline in the left, and '''false''' to hide it. (Default is '''true''' if not set)
*'''right''': Set '''true''' to show the outline in the right, and '''false''' to hide it. (Default is '''true''' if not set)
*'''top''': Set '''true''' to show the outline at the top, and '''false''' to hide it. (Default is '''true''' if not set)
*'''bottom''': Set '''true''' to show the outline at the bottom, and '''false''' to hide it. (Default is '''true''' if not set)

===renderEventCall===
Requires a bool value. Set whether [[onDgsElementRender]] is triggered when rendering. (Don't always enable this, or it will cause severely performance decrease)
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"renderEventCall",renderEventCall = false)</syntaxhighlight>
*'''renderEventCall:''' Set to true to enable, and false to disable.

===PixelInt===
Requires a bool value. Set whether the position/size of a dgs element is converted to integer while rendering, which deals with '''blur''' problem.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"PixelInt",PixelInt = true)</syntaxhighlight>
*'''PixelInt:''' Set to true to enable, and false to disable.

===postGUI===
Requires a bool value. Set whether the dgs element is post gui when render settings "postGUI" is ''nil''(automatic).
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"postGUI",postGUI)</syntaxhighlight>
*'''postGUI:''' Set to true to enable post gui, or it wil under gui.

===visible===
This property change the visibility of a dgs element. This is equivalent to [[dgsSetVisible]]/[[dgsGetVisible]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"visible",visible)</syntaxhighlight>
*'''visible:''' A bool indicates whether the dgs element is visible or not.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxswitchbutton

2022-03-17T10:43:02Z

Zhvachka: /* wordbreak */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxswitchbutton that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===clickType===
This property determines which button on mouse can change the state of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"clickType",clickType)</syntaxhighlight>
*'''clickType:''' An integer, available values are as follows:
**'''1:''' Left Mouse Button
**'''2:''' Wheel
**'''3:''' Right Mouse Button

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===cursorMoveSpeed===
This property determines the cursor moving speed when switch button changes state.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorMoveSpeed",cursorMoveSpeed)</syntaxhighlight>
*'''cursorMoveSpeed:''' A float of the cursor moving speed when switch button changes state.

===cursorWidth===
This property determines the cursor width of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorWidth",cursorWidth)</syntaxhighlight>
*'''cursorWidth:''' A float of the cursor width of switch button.

===cursorLength===
This property determines the cursor length of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorLength",cursorLength)</syntaxhighlight>
*'''cursorLength:''' A float of the cursor length of switch button.

===colorcoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"colorcoded",colorcoded)</syntaxhighlight>
*'''colorcoded:''' Set to true to enable embedded #FFFFFF color codes.

===colorOn===
The color which can be translated by [[tocolor]] of the background color when the switch button turns on.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"colorOn",{normalColor,hoverColor,clickColor})</syntaxhighlight>
*'''normalColor:''' A integer of background color of turned on switch button.
*'''hoverColor:''' A integer of background color of turned on switch button when the mouse is hovering on it.
*'''clickColor:''' A integer of background color of turned on switch button when the mouse is clicked on it.

===colorOff===
The color which can be translated by [[tocolor]] of the background color when the switch button turns off.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"colorOff",{normalColor,hoverColor,clickColor})</syntaxhighlight>
*'''normalColor:''' A integer of background color of turned off switch button.
*'''hoverColor:''' A integer of background color of turned off switch button when the mouse is hovering on it.
*'''clickColor:''' A integer of background color of turned off switch button when the mouse is clicked on it.

===cursorColor===
The color which can be translated by [[tocolor]] of the cursor color.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorColor",{normalColor,hoverColor,clickColor})</syntaxhighlight>
*'''normalColor:''' A integer of cursor color of the switch button.
*'''hoverColor:''' A integer of cursor color of the switch button when the mouse is hovering on it.
*'''clickColor:''' A integer of cursor color of the switch button when the mouse is clicked on it.

===cursorImage===
The cursor image of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorImage",{normalColor,hoverColor,clickColor})</syntaxhighlight>
*'''normalImage:''' An material of cursor image of the switch button.
*'''hoverImage:''' An material of cursor image of the switch button when the mouse is hovering on it.
*'''clickImage:''' An material of cursor image of the switch button when the mouse is clicked on it.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the switch button.

===imageOn===
The background image of switch button when the state is on.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"imageOn",{normalImage,hoverImage,clickImage})</syntaxhighlight>
*'''normalImage:''' An material of background image of turned on switch button.
*'''hoverImage:''' An material of background image of turned on switch button when the mouse is hovering on it.
*'''clickImage:''' An material of background image of turned on switch button when the mouse is clicked on it.

===imageOff===
The background image of switch button when the state is off.(
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"imageOff",{normalImage,hoverImage,clickImage})</syntaxhighlight>
*'''normalImage:''' An material of background image of turned off switch button.
*'''hoverImage:''' An material of background image of turned off switch button when the mouse is hovering on it.
*'''clickImage:''' An material of background image of turned off switch button when the mouse is clicked on it.

===shadow===
The shadow text of the switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the switch button.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the switch button.
*'''color:''' An integer of the color of the shadow text of the switch button.
*'''outline:''' A bool of the outline state of the shadow text.

===state===
This property indicates the state of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"state",state)</syntaxhighlight>
*'''state:''' A bool indicates the state of switch button.
**'''true:''' Turns on
**'''false:''' Turns off

===stateAnim===
This stores the progress of cursor animation, which is not recommend to modify.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"stateAnim",stateAnim)</syntaxhighlight>
*'''stateAnim:''' A float of the cursor animation progress.

===style===
This property determines the state of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"style",style)</syntaxhighlight>
*'''style:''' Mixed, available values are as follows:
**'''false:''' Default, a switch button with fading color when changing state.
**'''1:''' Split background color for turned on and off ( also split images ).
**'''2:''' Split background color for turned on and off ( not split images ).

===textOn===
This property stores the text to be shown when the switch button turns on.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textOn",textOn)</syntaxhighlight>
*'''textOn:''' A string of the text of the switch button.

===textOff===
This property stores the text to be shown when the switch button turns off.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textOff",textOff)</syntaxhighlight>
*'''textOff:''' A string of the text of the switch button.

===textColorOn===
The color which can be translated by [[tocolor]] of the text when the switch button turns on.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textColor_t",textColor_t)</syntaxhighlight>
*'''textColor_t:''' An integer of the color of the text when the switch button turns on.

===textColorOff===
The color which can be translated by [[tocolor]] of the text when the switch button turns off.(State=false)
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textColor_f",textColor_f)</syntaxhighlight>
*'''textColor_f:''' An integer of the color of the text when the switch button turns off.

===textSize===
The scale of the text of the switch button. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the switch button.
*'''scaleY:''' A float of the 2D Y scale of the text of the switch button.

===troughWidth===
This property determines trough length of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"troughWidth",troughWidth)</syntaxhighlight>
*'''troughWidth:''' A float of the trough length of switch button.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxmemo

2022-03-17T10:16:42Z

Zhvachka: /* padding */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxmemo that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===allowCopy===
This property determines whether the content of memo can be copy(ctrl+c)/cut(ctrl+x)
<syntaxhighlight lang="lua">dgsSetProperty(memo,"allowCopy",allowCopy)</syntaxhighlight>
*'''allowCopy:''' A boolean value of the state of whether this memo allows users to copy something from it.

===padding===
This property determines the content padding from 4 sides of element (left/top/right/bottom)
<syntaxhighlight lang="lua">dgsSetProperty(memo,"padding", {horizontal, vertical})</syntaxhighlight>
*'''horizontal:''' A float of the horizontal padding in pixels.
*'''vertical:''' A float of the vertical padding in pixels.

===bgColor===
This property determines the background color of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor:''' An integer of the color that can be converted by [[tocolor]].

===bgColorBlur===
This property determines the background color of the memo when it is blurred.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"bgColorBlur",bgColorBlur)</syntaxhighlight>
*'''bgColorBlur:''' An integer of the color that can be converted by [[tocolor]], leave to nil to use bgColor.

===bgImage===
This property determines the background image of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage:''' A material element that serves as the background image of the memo (texture/shader/screen source/renderTarget).

===bgImageBlur===
This property determines the background image of the memo when it is blurred.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"bgImageBlur",bgImageBlur)</syntaxhighlight>
*'''bgImageBlur:''' A material element that serves as the background image of the memo (texture/shader/screen source/renderTarget), leave to nil to use bgImage.

===caretColor===
This property determines the color of the caret
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretColor",caretColor)</syntaxhighlight>
*'''caretColor:''' An integer of the color that can be converted by [[tocolor]].

===caretHeight===
The height of the caret of the memo (multiple of the font height).
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretHeight",caretHeight)</syntaxhighlight>
*'''caretHeight:''' A float of the caret height.

===caretOffset===
The offset of the caret of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretOffset",{offsetX,offsetY})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X position offset of the caret of the memo.
*'''offsetY:''' A float of the 2D Y position offset of the caret of the memo.

===caretPos===
The position in which the caret stays.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretPos",{index,line})</syntaxhighlight>
*'''index:''' An integer of the index of the text in current line of the memo.
*'''line:''' An integer of the line of the memo.

===caretStyle===
This is equivalent to [[dgsMemoSetCaretStyle]]/[[dgsMemoGetCaretStyle]].

This property allows us to change the style of caret of the memo. ( 0 is "|"; 1 is "_" )

Example(0):

This is Text|

Example(1):

This is Text_
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretStyle",caretStyle)</syntaxhighlight>
*'''caretStyle:''' An integer of the caret style of the memo.

===caretThick===
This property allows us to change the thickness of caret of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretThick",caretThick)</syntaxhighlight>
*'''caretThick:''' An integer of the thickness of the caret of the memo.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(memo,"font",font)</syntaxhighlight>
*'''font:''' A [[Element/DX_font|dx font element]] of the text font of the memo.

===memo===
This property stores a gui-memo which is used to input characters.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"memo",gmemo)</syntaxhighlight>
*'''gmemo:''' A gui-memo.

===readOnly===
This is equivalent to [[dgsMemoSetReadOnly]]/[[dgsMemoGetReadOnly]].
<syntaxhighlight lang="lua">dgsSetProperty(memo,"readOnly",readOnly)</syntaxhighlight>
*'''readOnly:''' A bool indicates whether the memo is only readable.

===readOnlyCaretShow===
Whether the caret of memo will show/hide under read-only mode.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"readOnlyCaretShow",readOnlyCaretShow)</syntaxhighlight>
*'''readOnlyCaretShow:''' A bool indicates whether the caret is shown or hidden when the memo is read-only.

===renderTarget===
This property stores a render target of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"renderTarget",renderTarget)</syntaxhighlight>
*'''renderTarget:''' A render target that is used to render the text.

===scrollbars===
This property stores two scroll bars which can be got by [[dgsMemoGetScrollBar]] of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"scrollbars",{Vertical,Horizontal})</syntaxhighlight>
*'''Vertical:''' A vertical scroll bar of the memo.
*'''Horizontal:''' A horizontal scroll bar of the memo.

===scrollBarThick===
This property allows us to change the thickness of scroll bars of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"scrollBarThick",scrollBarThick)</syntaxhighlight>
*'''scrollBarThick:''' An integer of the thickness of scroll bars of the memo.

===scrollSize===
This property determines how many lines will get scrolled out of the rendering area once when you are scrolling your mouse wheel.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"scrollSize",scrollSize)</syntaxhighlight>
*'''scrollSize:''' Lines to be scrolled.

===selectColorBlur===
The color which can be translated by [[tocolor]] of the rectangle of text selection of the memo when blurred.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"selectColorBlur",selectColorBlur)</syntaxhighlight>
*'''selectColorBlur:''' An integer of the color of the rectangle of text selection of the memo when blurred.

===selectColor===
The color which can be translated by [[tocolor]] of the rectangle of text selection of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"selectColor",selectColor)</syntaxhighlight>
*'''selectColor:''' An integer of the color of the rectangle of text selection of the memo.

===selectFrom===
The position from which the text is selected.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"selectFrom",{index,line})</syntaxhighlight>
*'''index:''' An integer of the index of the text in the line where the text is selected from of the memo.
*'''line:''' An integer of the line where the text is selected from of the memo.

===showLine===
This property stores the value of how many lines does the text move to top.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"showLine",line)</syntaxhighlight>
*'''line:''' An integer indicates how many lines does the text move to top.

===showPos===
This property stores the value of how many pixels of the text are moved to left.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"showPos",posX)</syntaxhighlight>
*'''posX:''' An integer indicates how many pixels of the text are moved to left.

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(memo,"text",text)</syntaxhighlight>
*'''text:''' A ''table'' of the text of the memo.( Because of multi lines, I use table instead of string )

===textColor===
The color which can be translated by [[tocolor]] of the text of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the memo.

===textLength===
This is for scroll bar detection. You had better not touch it.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"textLength",textlen)</syntaxhighlight>
*'''textlen:''' A table stores the length of text in every line.

===textSize===
The scale of the text of the memo. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(memo,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the memo.
*'''scaleY:''' A float of the 2D Y scale of the text of the memo.

===typingSound===
Typing sound, nil for disabled. This is equivalent to [[dgsMemoSetTypingSound]]/[[dgsMemoGetTypingSound]]
<syntaxhighlight lang="lua">dgsSetProperty(memo,"typingSound",typingSound)</syntaxhighlight>
*'''typingSound:''' A string of the path/url of typing sound.

===typingSoundVolume===
Typing sound, nil for disabled. This is equivalent to [[dgsMemoSetTypingSoundVolume]]/[[dgsMemoGetTypingSoundVolume]]
<syntaxhighlight lang="lua">dgsSetProperty(memo,"typingSoundVolume",typingSoundVolume)</syntaxhighlight>
*'''typingSoundVolume:''' A float of the volume of the typing sound. Range is from 0.0 to 1.0. This can go above 1.0 for amplification.

===wordWrap===
This property determines the word wrap state of dgs memo. This is equivalent to [[dgsMemoSetWordWrapState]]/[[dgsMemoGetWordWrapState]]
<syntaxhighlight lang="lua">dgsSetProperty(memo,"wordWrap",wordWrap)</syntaxhighlight>
*'''wordWarp:''' An integer or a bool of word wrap state, vaild state are as follows:
**'''false:''' Non-wordwrap
**'''1:''' Split via single character ( This will break a word into 2 parts )
**'''2:''' Split via word

==See Also==
{{DGSPROPERTIES}}

Dgs-dxcombobox

2022-03-17T09:49:12Z

Zhvachka: /* wordbreak */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxcombobox that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===arrow===
This property determines the arrow material of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"arrow",arrow)</syntaxhighlight>
*'''arrow:''' A material element (texture/shader/screen).

===alignment===
Alignment of the caption text within the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the caption text within the combo box. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the caption text within the combo box. Can be "top", "center" or "bottom".

===autoHideAfterSelected===
This property determines whether the drop down will be hide automatically after selected.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"autoHideAfterSelected",autoHideAfterSelected)</syntaxhighlight>
*'''autoHideAfterSelected:''' A bool indicates whether the drop down will be hide automatically after selected.

===autoSort===
This property determines whether auto sort is enabled. ''See [[dgsComboBoxSetAutoSortEnabled]]/[[dgsComboBoxGetAutoSortEnabled]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"autoSort",autoSort)</syntaxhighlight>
*'''autoSort:''' A bool of auto sort state.

===bgColor===
This property determines the background color of the combo box (behind items).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor:''' An integer of the color that can be converted by [[tocolor]].

===bgImage===
This property determines the background image of the combo box (behind items).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage:''' A material element that serves as the background image of the combo box (texture/shader/screen source/renderTarget).

===buttonLen===
This property stores the width of the arrow button.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"buttonLen",{buttonLen,relative})</syntaxhighlight>
*'''buttonLen:''' A float of the width of arrow button, which is affected by '''relative'''.
*'''relative:''' If set to ''true'', '''buttonLen''' will range from 0 to 1 relative to combo box's height, otherwise the '''buttonLen''' will be absolute pixels.

===captionEdit===
This property stores the caption edit when the caption is editable with [[dgsComboBoxSetEditEnabled]].
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"captionEdit",captionEdit)</syntaxhighlight>
*'''captionEdit:''' A dgs-dxedit element.

===caption===
This property stores the caption text of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"caption",caption)</syntaxhighlight>
*'''caption:''' A string of the caption text of the combo box.

===clip===
Whether the clip property is enabled (include caption text and item text). ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===color===
The color which can be translated by [[tocolor]] of the background of the combobox (behind arrow).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"color",{normalColor,hoveringColor,clickedColor})</syntaxhighlight>
*'''normalColor:''' An integer of the color of the combobox ( neither selected nor clicked by mouse ).
*'''hoveringColor:''' An integer of the color of the combobox which is selected.
*'''clickedColor:''' An integer of the color of the comboox which is clicked.

===colorcoded===
Whether the color code is enabled (include caption text and item text). ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"colorcoded",colorcoded)</syntaxhighlight>
*'''colorcoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the combo box.

===scrollBarThick===
This property determines the thickness of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"scrollBarThick",scrollBarThick)</syntaxhighlight>
*'''scrollBarThick:''' An integer of the thickness of scroll bar.

===shadow===
The shadow of the text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the combo box.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the combo box.
*'''color:''' An integer of the color of the shadow text of the combo box.
*'''outline:''' A bool of the outline state of the shadow text.

===myBox===
Combo box is composed by dgs-dxcombobox and dgs-dxcombobox-Box. This property stores the dgs-combobox-Box of dgs-dxcombobox.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"myBox",myBox)</syntaxhighlight>
*'''myBox:''' A dgs-dxcombobox-box element.

===image===
The image of combo box ( under arrow ).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"image",{normalImage,hoveringImage,clickedImage})</syntaxhighlight>
*'''normalImage:''' A texture element of the background of the combobox ( no mouse enter and no mouse click ).
*'''hoveringImage:''' A texture element of the background of the combobox which is selected.
*'''clickedImage:''' A texture element of the background of the combobox which is clicked.

===itemAlignment===
Alignment of the item text within the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemAlignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the item text within the combo box. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the item text within the combo box. Can be "top", "center" or "bottom".

===itemTextPadding===
This property determines the item text padding of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextPadding",{paddingX,paddingY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===itemColor===
This property determines the 3 states' back ground colors of item.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemColor",{colorNormal,colorHoving,colorSelected})</syntaxhighlight>
*'''colorNormal:''' An integer of the color of the item (Normal State).
*'''colorHoving:''' An integer of the color of the item (Hoving State).
*'''colorSelected:''' An integer of the color of the item (Selected State).

===itemData===
This property stores item data.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"itemData",itemData)</syntaxhighlight>
*'''columnData:''' A table stores all item data.
'''Item Structure'''
<syntaxhighlight lang="lua">
{
textColor BackGround Image BackGround Color Text
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{ ... },
}
]]
</syntaxhighlight>

===itemImage===
This property determines the 3 states' background image of item.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemImage",{imageNormal,imageHoving,imageSelected})</syntaxhighlight>
*'''imageNormal:''' A texture of the image of the row (Normal State).
*'''imageHoving:''' A texture of the image of the row (Hoving State).
*'''imageSelected:''' A texture of the image of the row (Selected State).

===itemMoveOffset===
This property stores the move offset of item that is used to render.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemMoveOffset",itemMoveOffset)</syntaxhighlight>
*'''itemMoveOffset:''' A float stores the move offset of item that is used to render.

===itemTextColor===
This property determines the color of the item text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextColor",itemTextColor)</syntaxhighlight>
*'''itemTextColor:''' An integer of the color that can be converted by [[tocolor]].

===itemTextSize===
This property determines the scale of the item text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the item.
*'''scaleY:''' A float of the 2D Y scale of the text of the item.

===listState===
This property stores the state of combo box which determines whether the combo box is opened(1) or closed(-1).
See: [[dgsComboBoxGetState]]/[[dgsComboBoxSetState]]
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"listState",listState)</syntaxhighlight>
*'''listState:''' An integer of the state of combo box.

===moveHardness===
This property determines how hard will the combo box moves when scrolling.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"moveHardness",moveHardness)</syntaxhighlight>
*'''moveHardness:''' A float determins how hard will the combo box moves when scrolling ( should be larger than 0, lower than 1 ).

===scrollbar===
This property stores the scroll bar of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"scrollbar",scrollbar)</syntaxhighlight>
*'''scrollbar:''' a dgs-dxscrollbar element.

===select===
This property stores the selected item of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"select",select)</syntaxhighlight>
*'''select:''' A integer of the index of selected item .

===textColor===
The color which can be translated by [[tocolor]] of the caption text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the combo box.

===textPadding===
This property determines the caption text padding of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textPadding",{paddingX,paddingY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===textSize===
The scale of the capiton text of the combo box. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the combo box.
*'''scaleY:''' A float of the 2D Y scale of the text of the combo box.

===textBox===
This property determines whether the '''caption''' of combo box is enabled or not.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textBox",textBox)</syntaxhighlight>
*'''textBox:''' A bool indicates whether the '''caption''' of combo box is enabled or not.

===wordBreak===
Whether the word-break of capiton text is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(capiton ,"wordBreak",wordbreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==Property of dgs-dxcombobox-Box==
===myCombo===
Combo box is composed by dgs-dxcombobox and dgs-dxcombobox-Box. This property stores the dgs-combobox of dgs-dxcombobox-Box.
<syntaxhighlight lang="lua">dgsSetProperty(myCombo,"myCombo",myCombo)</syntaxhighlight>
*'''myComboyBox:''' A dgs-dxcombobox element.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxcheckbox

2022-03-16T17:57:33Z

Zhvachka: /* image_t */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxcheckbox that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the text within the checkbox.

The functions as follows are basic on this property.

[[dgsCheckBoxSetHorizontalAlign]]/[[dgsCheckBoxGetHorizontalAlign]]

[[dgsCheckBoxSetVerticalAlign]]/[[dgsCheckBoxGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(checkbx,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the checkbox. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the checkbox. Can be "top", "center" or "bottom".

===buttonSize===
This property determines the button size of the check box.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"buttonSize",{size,relative})</syntaxhighlight>
*'''size:''' A number of the size of the button on screen.
*'''relative:''' A bool indicates whether the size is relative or absolute.

<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"buttonSize",{width,height,relative})</syntaxhighlight>
*'''width:''' A number of the width of the button on screen.
*'''height:''' A number of the height of the button on screen.
*'''relative:''' A bool indicates whether the size is relative or absolute.

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===colorIndeterminate===
This property determines the color of the icon under 3 conditions when the check box is indeterminate.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorIndeterminate",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (indeterminate)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (indeterminate)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (indeterminate)

===colorUnchecked===
This property determines the color of the icon under 3 conditions when the check box is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorUnchecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (unchecked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (unchecked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (unchecked)

===colorChecked===
This property determines the color of the icon under 3 conditions when the check box is checked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorChecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (checked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (checked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (checked)

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the checkbox.

===imageUnchecked===
This property determines the icon under 3 conditions when the check box is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"imageUnchecked",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (unchecked)
*'''ImageHover:''' An image element of the icon under hovering state. (unchecked)
*'''ImageClick:''' An image element of the icon under clicked state. (unchecked)

===imageIndeterminate===
This property determines the icon under 3 conditions when the check box is indeterminate.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"imageIndeterminate",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (indeterminate)
*'''ImageHover:''' An image element of the icon under hovering state. (indeterminate)
*'''ImageClick:''' An image element of the icon under clicked state. (indeterminate)

===imageChecked===
This property determines the icon under 3 conditions when the check box is checked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"imageChecked",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (checked)
*'''ImageHover:''' An image element of the icon under hovering state. (checked)
*'''ImageClick:''' An image element of the icon under clicked state. (checked)

===shadow===
The shadow text of the checkbox.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the checkbox.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the checkbox.
*'''color:''' An integer of the color of the shadow text of the checkbox.
*'''outline:''' A bool of the outline state of the shadow text.

===state===
This property stores the state of the check box.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"state",state)</syntaxhighlight>
*'''state:''' A bool/nil of the state. Values can be as follows:
**'''true:''' Checked
**'''false:''' Unchecked
**'''nil:''' indeterminate

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"text",text)</syntaxhighlight>
*'''text:''' A string of the text of the checkbox.

===textColor===
The color which can be translated by [[tocolor]] of the text of the checkbox.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the checkbox.

===textPadding===
This property determines the padding between the text and icon.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textPadding",textPadding)</syntaxhighlight>
*'''textPadding''' A float of the distance from the icon to the text of the check box.

===textSize===
The scale of the text of the checkbox. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the checkbox.
*'''scaleY:''' A float of the 2D Y scale of the text of the checkbox.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxcheckbox

2022-03-16T17:56:48Z

Zhvachka: /* image_i */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxcheckbox that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the text within the checkbox.

The functions as follows are basic on this property.

[[dgsCheckBoxSetHorizontalAlign]]/[[dgsCheckBoxGetHorizontalAlign]]

[[dgsCheckBoxSetVerticalAlign]]/[[dgsCheckBoxGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(checkbx,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the checkbox. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the checkbox. Can be "top", "center" or "bottom".

===buttonSize===
This property determines the button size of the check box.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"buttonSize",{size,relative})</syntaxhighlight>
*'''size:''' A number of the size of the button on screen.
*'''relative:''' A bool indicates whether the size is relative or absolute.

<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"buttonSize",{width,height,relative})</syntaxhighlight>
*'''width:''' A number of the width of the button on screen.
*'''height:''' A number of the height of the button on screen.
*'''relative:''' A bool indicates whether the size is relative or absolute.

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===colorIndeterminate===
This property determines the color of the icon under 3 conditions when the check box is indeterminate.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorIndeterminate",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (indeterminate)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (indeterminate)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (indeterminate)

===colorUnchecked===
This property determines the color of the icon under 3 conditions when the check box is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorUnchecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (unchecked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (unchecked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (unchecked)

===colorChecked===
This property determines the color of the icon under 3 conditions when the check box is checked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorChecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (checked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (checked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (checked)

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the checkbox.

===imageUnchecked===
This property determines the icon under 3 conditions when the check box is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"imageUnchecked",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (unchecked)
*'''ImageHover:''' An image element of the icon under hovering state. (unchecked)
*'''ImageClick:''' An image element of the icon under clicked state. (unchecked)

===imageIndeterminate===
This property determines the icon under 3 conditions when the check box is indeterminate.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"imageIndeterminate",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (indeterminate)
*'''ImageHover:''' An image element of the icon under hovering state. (indeterminate)
*'''ImageClick:''' An image element of the icon under clicked state. (indeterminate)

===image_t===
This property determines the icon under 3 conditions when the check box is checked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"image_t",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (checked)
*'''ImageHover:''' An image element of the icon under hovering state. (checked)
*'''ImageClick:''' An image element of the icon under clicked state. (checked)

===shadow===
The shadow text of the checkbox.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the checkbox.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the checkbox.
*'''color:''' An integer of the color of the shadow text of the checkbox.
*'''outline:''' A bool of the outline state of the shadow text.

===state===
This property stores the state of the check box.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"state",state)</syntaxhighlight>
*'''state:''' A bool/nil of the state. Values can be as follows:
**'''true:''' Checked
**'''false:''' Unchecked
**'''nil:''' indeterminate

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"text",text)</syntaxhighlight>
*'''text:''' A string of the text of the checkbox.

===textColor===
The color which can be translated by [[tocolor]] of the text of the checkbox.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the checkbox.

===textPadding===
This property determines the padding between the text and icon.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textPadding",textPadding)</syntaxhighlight>
*'''textPadding''' A float of the distance from the icon to the text of the check box.

===textSize===
The scale of the text of the checkbox. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the checkbox.
*'''scaleY:''' A float of the 2D Y scale of the text of the checkbox.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxcheckbox

2022-03-16T17:55:55Z

Zhvachka: /* image_f */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxcheckbox that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the text within the checkbox.

The functions as follows are basic on this property.

[[dgsCheckBoxSetHorizontalAlign]]/[[dgsCheckBoxGetHorizontalAlign]]

[[dgsCheckBoxSetVerticalAlign]]/[[dgsCheckBoxGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(checkbx,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the checkbox. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the checkbox. Can be "top", "center" or "bottom".

===buttonSize===
This property determines the button size of the check box.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"buttonSize",{size,relative})</syntaxhighlight>
*'''size:''' A number of the size of the button on screen.
*'''relative:''' A bool indicates whether the size is relative or absolute.

<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"buttonSize",{width,height,relative})</syntaxhighlight>
*'''width:''' A number of the width of the button on screen.
*'''height:''' A number of the height of the button on screen.
*'''relative:''' A bool indicates whether the size is relative or absolute.

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===colorIndeterminate===
This property determines the color of the icon under 3 conditions when the check box is indeterminate.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorIndeterminate",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (indeterminate)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (indeterminate)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (indeterminate)

===colorUnchecked===
This property determines the color of the icon under 3 conditions when the check box is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorUnchecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (unchecked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (unchecked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (unchecked)

===colorChecked===
This property determines the color of the icon under 3 conditions when the check box is checked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorChecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (checked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (checked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (checked)

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the checkbox.

===imageUnchecked===
This property determines the icon under 3 conditions when the check box is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"imageUnchecked",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (unchecked)
*'''ImageHover:''' An image element of the icon under hovering state. (unchecked)
*'''ImageClick:''' An image element of the icon under clicked state. (unchecked)

===image_i===
This property determines the icon under 3 conditions when the check box is indeterminate.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"image_i",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (indeterminate)
*'''ImageHover:''' An image element of the icon under hovering state. (indeterminate)
*'''ImageClick:''' An image element of the icon under clicked state. (indeterminate)

===image_t===
This property determines the icon under 3 conditions when the check box is checked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"image_t",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (checked)
*'''ImageHover:''' An image element of the icon under hovering state. (checked)
*'''ImageClick:''' An image element of the icon under clicked state. (checked)

===shadow===
The shadow text of the checkbox.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the checkbox.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the checkbox.
*'''color:''' An integer of the color of the shadow text of the checkbox.
*'''outline:''' A bool of the outline state of the shadow text.

===state===
This property stores the state of the check box.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"state",state)</syntaxhighlight>
*'''state:''' A bool/nil of the state. Values can be as follows:
**'''true:''' Checked
**'''false:''' Unchecked
**'''nil:''' indeterminate

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"text",text)</syntaxhighlight>
*'''text:''' A string of the text of the checkbox.

===textColor===
The color which can be translated by [[tocolor]] of the text of the checkbox.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the checkbox.

===textPadding===
This property determines the padding between the text and icon.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textPadding",textPadding)</syntaxhighlight>
*'''textPadding''' A float of the distance from the icon to the text of the check box.

===textSize===
The scale of the text of the checkbox. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the checkbox.
*'''scaleY:''' A float of the 2D Y scale of the text of the checkbox.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxcheckbox

2022-03-16T17:55:06Z

Zhvachka: /* color_t */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxcheckbox that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the text within the checkbox.

The functions as follows are basic on this property.

[[dgsCheckBoxSetHorizontalAlign]]/[[dgsCheckBoxGetHorizontalAlign]]

[[dgsCheckBoxSetVerticalAlign]]/[[dgsCheckBoxGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(checkbx,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the checkbox. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the checkbox. Can be "top", "center" or "bottom".

===buttonSize===
This property determines the button size of the check box.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"buttonSize",{size,relative})</syntaxhighlight>
*'''size:''' A number of the size of the button on screen.
*'''relative:''' A bool indicates whether the size is relative or absolute.

<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"buttonSize",{width,height,relative})</syntaxhighlight>
*'''width:''' A number of the width of the button on screen.
*'''height:''' A number of the height of the button on screen.
*'''relative:''' A bool indicates whether the size is relative or absolute.

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===colorIndeterminate===
This property determines the color of the icon under 3 conditions when the check box is indeterminate.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorIndeterminate",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (indeterminate)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (indeterminate)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (indeterminate)

===colorUnchecked===
This property determines the color of the icon under 3 conditions when the check box is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorUnchecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (unchecked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (unchecked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (unchecked)

===colorChecked===
This property determines the color of the icon under 3 conditions when the check box is checked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorChecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (checked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (checked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (checked)

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the checkbox.

===image_f===
This property determines the icon under 3 conditions when the check box is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"image_f",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (unchecked)
*'''ImageHover:''' An image element of the icon under hovering state. (unchecked)
*'''ImageClick:''' An image element of the icon under clicked state. (unchecked)

===image_i===
This property determines the icon under 3 conditions when the check box is indeterminate.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"image_i",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (indeterminate)
*'''ImageHover:''' An image element of the icon under hovering state. (indeterminate)
*'''ImageClick:''' An image element of the icon under clicked state. (indeterminate)

===image_t===
This property determines the icon under 3 conditions when the check box is checked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"image_t",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (checked)
*'''ImageHover:''' An image element of the icon under hovering state. (checked)
*'''ImageClick:''' An image element of the icon under clicked state. (checked)

===shadow===
The shadow text of the checkbox.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the checkbox.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the checkbox.
*'''color:''' An integer of the color of the shadow text of the checkbox.
*'''outline:''' A bool of the outline state of the shadow text.

===state===
This property stores the state of the check box.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"state",state)</syntaxhighlight>
*'''state:''' A bool/nil of the state. Values can be as follows:
**'''true:''' Checked
**'''false:''' Unchecked
**'''nil:''' indeterminate

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"text",text)</syntaxhighlight>
*'''text:''' A string of the text of the checkbox.

===textColor===
The color which can be translated by [[tocolor]] of the text of the checkbox.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the checkbox.

===textPadding===
This property determines the padding between the text and icon.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textPadding",textPadding)</syntaxhighlight>
*'''textPadding''' A float of the distance from the icon to the text of the check box.

===textSize===
The scale of the text of the checkbox. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the checkbox.
*'''scaleY:''' A float of the 2D Y scale of the text of the checkbox.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxcheckbox

2022-03-16T17:54:20Z

Zhvachka: /* color_f */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxcheckbox that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the text within the checkbox.

The functions as follows are basic on this property.

[[dgsCheckBoxSetHorizontalAlign]]/[[dgsCheckBoxGetHorizontalAlign]]

[[dgsCheckBoxSetVerticalAlign]]/[[dgsCheckBoxGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(checkbx,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the checkbox. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the checkbox. Can be "top", "center" or "bottom".

===buttonSize===
This property determines the button size of the check box.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"buttonSize",{size,relative})</syntaxhighlight>
*'''size:''' A number of the size of the button on screen.
*'''relative:''' A bool indicates whether the size is relative or absolute.

<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"buttonSize",{width,height,relative})</syntaxhighlight>
*'''width:''' A number of the width of the button on screen.
*'''height:''' A number of the height of the button on screen.
*'''relative:''' A bool indicates whether the size is relative or absolute.

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===colorIndeterminate===
This property determines the color of the icon under 3 conditions when the check box is indeterminate.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorIndeterminate",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (indeterminate)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (indeterminate)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (indeterminate)

===colorUnchecked===
This property determines the color of the icon under 3 conditions when the check box is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorUnchecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (unchecked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (unchecked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (unchecked)

===color_t===
This property determines the color of the icon under 3 conditions when the check box is checked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"color_t",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (checked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (checked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (checked)

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the checkbox.

===image_f===
This property determines the icon under 3 conditions when the check box is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"image_f",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (unchecked)
*'''ImageHover:''' An image element of the icon under hovering state. (unchecked)
*'''ImageClick:''' An image element of the icon under clicked state. (unchecked)

===image_i===
This property determines the icon under 3 conditions when the check box is indeterminate.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"image_i",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (indeterminate)
*'''ImageHover:''' An image element of the icon under hovering state. (indeterminate)
*'''ImageClick:''' An image element of the icon under clicked state. (indeterminate)

===image_t===
This property determines the icon under 3 conditions when the check box is checked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"image_t",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (checked)
*'''ImageHover:''' An image element of the icon under hovering state. (checked)
*'''ImageClick:''' An image element of the icon under clicked state. (checked)

===shadow===
The shadow text of the checkbox.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the checkbox.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the checkbox.
*'''color:''' An integer of the color of the shadow text of the checkbox.
*'''outline:''' A bool of the outline state of the shadow text.

===state===
This property stores the state of the check box.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"state",state)</syntaxhighlight>
*'''state:''' A bool/nil of the state. Values can be as follows:
**'''true:''' Checked
**'''false:''' Unchecked
**'''nil:''' indeterminate

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"text",text)</syntaxhighlight>
*'''text:''' A string of the text of the checkbox.

===textColor===
The color which can be translated by [[tocolor]] of the text of the checkbox.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the checkbox.

===textPadding===
This property determines the padding between the text and icon.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textPadding",textPadding)</syntaxhighlight>
*'''textPadding''' A float of the distance from the icon to the text of the check box.

===textSize===
The scale of the text of the checkbox. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the checkbox.
*'''scaleY:''' A float of the 2D Y scale of the text of the checkbox.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxcheckbox

2022-03-16T17:53:29Z

Zhvachka: /* color_i */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxcheckbox that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the text within the checkbox.

The functions as follows are basic on this property.

[[dgsCheckBoxSetHorizontalAlign]]/[[dgsCheckBoxGetHorizontalAlign]]

[[dgsCheckBoxSetVerticalAlign]]/[[dgsCheckBoxGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(checkbx,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the checkbox. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the checkbox. Can be "top", "center" or "bottom".

===buttonSize===
This property determines the button size of the check box.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"buttonSize",{size,relative})</syntaxhighlight>
*'''size:''' A number of the size of the button on screen.
*'''relative:''' A bool indicates whether the size is relative or absolute.

<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"buttonSize",{width,height,relative})</syntaxhighlight>
*'''width:''' A number of the width of the button on screen.
*'''height:''' A number of the height of the button on screen.
*'''relative:''' A bool indicates whether the size is relative or absolute.

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===colorIndeterminate===
This property determines the color of the icon under 3 conditions when the check box is indeterminate.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorIndeterminate",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (indeterminate)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (indeterminate)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (indeterminate)

===color_f===
This property determines the color of the icon under 3 conditions when the check box is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"color_f",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (unchecked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (unchecked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (unchecked)

===color_t===
This property determines the color of the icon under 3 conditions when the check box is checked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"color_t",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (checked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (checked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (checked)

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the checkbox.

===image_f===
This property determines the icon under 3 conditions when the check box is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"image_f",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (unchecked)
*'''ImageHover:''' An image element of the icon under hovering state. (unchecked)
*'''ImageClick:''' An image element of the icon under clicked state. (unchecked)

===image_i===
This property determines the icon under 3 conditions when the check box is indeterminate.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"image_i",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (indeterminate)
*'''ImageHover:''' An image element of the icon under hovering state. (indeterminate)
*'''ImageClick:''' An image element of the icon under clicked state. (indeterminate)

===image_t===
This property determines the icon under 3 conditions when the check box is checked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"image_t",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (checked)
*'''ImageHover:''' An image element of the icon under hovering state. (checked)
*'''ImageClick:''' An image element of the icon under clicked state. (checked)

===shadow===
The shadow text of the checkbox.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the checkbox.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the checkbox.
*'''color:''' An integer of the color of the shadow text of the checkbox.
*'''outline:''' A bool of the outline state of the shadow text.

===state===
This property stores the state of the check box.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"state",state)</syntaxhighlight>
*'''state:''' A bool/nil of the state. Values can be as follows:
**'''true:''' Checked
**'''false:''' Unchecked
**'''nil:''' indeterminate

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"text",text)</syntaxhighlight>
*'''text:''' A string of the text of the checkbox.

===textColor===
The color which can be translated by [[tocolor]] of the text of the checkbox.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the checkbox.

===textPadding===
This property determines the padding between the text and icon.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textPadding",textPadding)</syntaxhighlight>
*'''textPadding''' A float of the distance from the icon to the text of the check box.

===textSize===
The scale of the text of the checkbox. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the checkbox.
*'''scaleY:''' A float of the 2D Y scale of the text of the checkbox.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxradiobutton

2022-03-16T17:52:15Z

Zhvachka: /* image_t */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxradiobutton that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the text within the radiobutton.

The functions as follows are basic on this property.

[[dgsRadioButtonSetHorizontalAlign]]/[[dgsRadioButtonGetHorizontalAlign]]

[[dgsRadioButtonSetVerticalAlign]]/[[dgsRadioButtonGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(checkbx,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the radiobutton. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the radiobutton. Can be "top", "center" or "bottom".

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===colorUnchecked===
This property determines the color of the icon under 3 conditions when the radio button is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"colorUnchecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (unchecked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (unchecked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (unchecked)

===colorChecked===
This property determines the color of the icon under 3 conditions when the radio button is checked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"colorChecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (checked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (checked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (checked)

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the radiobutton.

===imageUnchecked===
This property determines the icon under 3 conditions when the radio button is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"imageUnchecked",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (unchecked)
*'''ImageHover:''' An image element of the icon under hovering state. (unchecked)
*'''ImageClick:''' An image element of the icon under clicked state. (unchecked)

===imageChecked===
This property determines the icon under 3 conditions when the radio button is checked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"imageChecked",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (checked)
*'''ImageHover:''' An image element of the icon under hovering state. (checked)
*'''ImageClick:''' An image element of the icon under clicked state. (checked)

===shadow===
The shadow text of the radiobutton.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the radiobutton.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the radiobutton.
*'''color:''' An integer of the color of the shadow text of the radiobutton.
*'''outline:''' A bool of the outline state of the shadow text.

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"text",text)</syntaxhighlight>
*'''text:''' A string of the text of the radiobutton.

===textColor===
The color which can be translated by [[tocolor]] of the text of the radiobutton.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the radiobutton.

===textPadding===
This property determines the padding between the text and icon.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textPadding",textPadding)</syntaxhighlight>
*'''textPadding:''' A float of the distance from the icon to the text of the radio button.

===textSize===
The scale of the text of the radiobutton. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the radiobutton.
*'''scaleY:''' A float of the 2D Y scale of the text of the radiobutton.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==Additional Property For Parent Element==
===RadioButton===
This property stores which radio button is selected.
<syntaxhighlight lang="lua">dgsSetProperty(parent,"RadioButton",RadioButton)</syntaxhighlight>
*'''RadioButton:''' The radio button that is selected.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxradiobutton

2022-03-16T17:51:32Z

Zhvachka: /* image_f */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxradiobutton that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the text within the radiobutton.

The functions as follows are basic on this property.

[[dgsRadioButtonSetHorizontalAlign]]/[[dgsRadioButtonGetHorizontalAlign]]

[[dgsRadioButtonSetVerticalAlign]]/[[dgsRadioButtonGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(checkbx,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the radiobutton. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the radiobutton. Can be "top", "center" or "bottom".

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===colorUnchecked===
This property determines the color of the icon under 3 conditions when the radio button is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"colorUnchecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (unchecked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (unchecked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (unchecked)

===colorChecked===
This property determines the color of the icon under 3 conditions when the radio button is checked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"colorChecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (checked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (checked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (checked)

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the radiobutton.

===imageUnchecked===
This property determines the icon under 3 conditions when the radio button is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"imageUnchecked",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (unchecked)
*'''ImageHover:''' An image element of the icon under hovering state. (unchecked)
*'''ImageClick:''' An image element of the icon under clicked state. (unchecked)

===image_t===
This property determines the icon under 3 conditions when the radio button is checked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"image_t",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (checked)
*'''ImageHover:''' An image element of the icon under hovering state. (checked)
*'''ImageClick:''' An image element of the icon under clicked state. (checked)

===shadow===
The shadow text of the radiobutton.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the radiobutton.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the radiobutton.
*'''color:''' An integer of the color of the shadow text of the radiobutton.
*'''outline:''' A bool of the outline state of the shadow text.

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"text",text)</syntaxhighlight>
*'''text:''' A string of the text of the radiobutton.

===textColor===
The color which can be translated by [[tocolor]] of the text of the radiobutton.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the radiobutton.

===textPadding===
This property determines the padding between the text and icon.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textPadding",textPadding)</syntaxhighlight>
*'''textPadding:''' A float of the distance from the icon to the text of the radio button.

===textSize===
The scale of the text of the radiobutton. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the radiobutton.
*'''scaleY:''' A float of the 2D Y scale of the text of the radiobutton.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==Additional Property For Parent Element==
===RadioButton===
This property stores which radio button is selected.
<syntaxhighlight lang="lua">dgsSetProperty(parent,"RadioButton",RadioButton)</syntaxhighlight>
*'''RadioButton:''' The radio button that is selected.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxradiobutton

2022-03-16T17:50:37Z

Zhvachka: /* color_f */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxradiobutton that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the text within the radiobutton.

The functions as follows are basic on this property.

[[dgsRadioButtonSetHorizontalAlign]]/[[dgsRadioButtonGetHorizontalAlign]]

[[dgsRadioButtonSetVerticalAlign]]/[[dgsRadioButtonGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(checkbx,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the radiobutton. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the radiobutton. Can be "top", "center" or "bottom".

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===colorUnchecked===
This property determines the color of the icon under 3 conditions when the radio button is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"colorUnchecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (unchecked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (unchecked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (unchecked)

===colorChecked===
This property determines the color of the icon under 3 conditions when the radio button is checked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"colorChecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (checked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (checked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (checked)

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the radiobutton.

===image_f===
This property determines the icon under 3 conditions when the radio button is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"image_f",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (unchecked)
*'''ImageHover:''' An image element of the icon under hovering state. (unchecked)
*'''ImageClick:''' An image element of the icon under clicked state. (unchecked)

===image_t===
This property determines the icon under 3 conditions when the radio button is checked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"image_t",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (checked)
*'''ImageHover:''' An image element of the icon under hovering state. (checked)
*'''ImageClick:''' An image element of the icon under clicked state. (checked)

===shadow===
The shadow text of the radiobutton.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the radiobutton.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the radiobutton.
*'''color:''' An integer of the color of the shadow text of the radiobutton.
*'''outline:''' A bool of the outline state of the shadow text.

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"text",text)</syntaxhighlight>
*'''text:''' A string of the text of the radiobutton.

===textColor===
The color which can be translated by [[tocolor]] of the text of the radiobutton.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the radiobutton.

===textPadding===
This property determines the padding between the text and icon.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textPadding",textPadding)</syntaxhighlight>
*'''textPadding:''' A float of the distance from the icon to the text of the radio button.

===textSize===
The scale of the text of the radiobutton. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the radiobutton.
*'''scaleY:''' A float of the 2D Y scale of the text of the radiobutton.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==Additional Property For Parent Element==
===RadioButton===
This property stores which radio button is selected.
<syntaxhighlight lang="lua">dgsSetProperty(parent,"RadioButton",RadioButton)</syntaxhighlight>
*'''RadioButton:''' The radio button that is selected.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxradiobutton

2022-03-16T17:49:51Z

Zhvachka: /* color_t */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxradiobutton that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the text within the radiobutton.

The functions as follows are basic on this property.

[[dgsRadioButtonSetHorizontalAlign]]/[[dgsRadioButtonGetHorizontalAlign]]

[[dgsRadioButtonSetVerticalAlign]]/[[dgsRadioButtonGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(checkbx,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the radiobutton. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the radiobutton. Can be "top", "center" or "bottom".

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===color_f===
This property determines the color of the icon under 3 conditions when the radio button is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"color_f",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (unchecked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (unchecked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (unchecked)

===colorChecked===
This property determines the color of the icon under 3 conditions when the radio button is checked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"colorChecked",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (checked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (checked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (checked)

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the radiobutton.

===image_f===
This property determines the icon under 3 conditions when the radio button is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"image_f",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (unchecked)
*'''ImageHover:''' An image element of the icon under hovering state. (unchecked)
*'''ImageClick:''' An image element of the icon under clicked state. (unchecked)

===image_t===
This property determines the icon under 3 conditions when the radio button is checked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"image_t",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (checked)
*'''ImageHover:''' An image element of the icon under hovering state. (checked)
*'''ImageClick:''' An image element of the icon under clicked state. (checked)

===shadow===
The shadow text of the radiobutton.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the radiobutton.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the radiobutton.
*'''color:''' An integer of the color of the shadow text of the radiobutton.
*'''outline:''' A bool of the outline state of the shadow text.

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"text",text)</syntaxhighlight>
*'''text:''' A string of the text of the radiobutton.

===textColor===
The color which can be translated by [[tocolor]] of the text of the radiobutton.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the radiobutton.

===textPadding===
This property determines the padding between the text and icon.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textPadding",textPadding)</syntaxhighlight>
*'''textPadding:''' A float of the distance from the icon to the text of the radio button.

===textSize===
The scale of the text of the radiobutton. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the radiobutton.
*'''scaleY:''' A float of the 2D Y scale of the text of the radiobutton.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==Additional Property For Parent Element==
===RadioButton===
This property stores which radio button is selected.
<syntaxhighlight lang="lua">dgsSetProperty(parent,"RadioButton",RadioButton)</syntaxhighlight>
*'''RadioButton:''' The radio button that is selected.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxwindow

2022-03-16T17:29:53Z

Zhvachka: /* colorcoded */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxwindow that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the title text of the window.

The functions as follows are based on this property.

[[dgsWindowSetHorizontalAlign]]/[[dgsWindowGetHorizontalAlign]]

[[dgsWindowSetVerticalAlign]]/[[dgsWindowGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(window,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the title text of the windowl. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the title text of the window. Can be "top", "center" or "bottom".

===borderSize===
This property determines the border size in pixels which is used to resize the window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"borderSize",borderSize)</syntaxhighlight>
*'''borderSize:''' An integer of the size of the border of the window in pixels.

===color===
The color which can be translated by [[tocolor]] of the background of the window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"color",color)</syntaxhighlight>
*'''color:''' An integer of the color of the background of the window.

===colorCoded===
Whether the color code in the title text is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(window,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(window,"font",font)</syntaxhighlight>
*'''font:''' A [[Element/DX_font|dx font element]] of the title text font of the window.

===ignoreTitle===
This property determines whether to ignore the window title when calculating window's child elements (useful for gui to dgs).
<syntaxhighlight lang="lua">dgsSetProperty(window,"ignoreTitle",ignoreTitle)</syntaxhighlight>
*'''ignoreTitle:''' A bool of the state of whether to ignore the window title.

===image===
The texture element(texture/render target/screen source/shader etc) of the background of the window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"image",image)</syntaxhighlight>
*'''image:''' A texture element of the background of the window.

===maxSize===
This property determines the maximum width and height of the window that users can resize to.
<syntaxhighlight lang="lua">dgsSetProperty(window,"maxSize",{maxWidth,maxHeight})</syntaxhighlight>
*'''maxWidth:''' An integer of the maximum width of the window.
*'''maxHeight:''' An integer of the maximum height of the window.

===minSize===
This property determines the minimum width and height of the window that users can resize to.
<syntaxhighlight lang="lua">dgsSetProperty(window,"minSize",{minWidth,minHeight})</syntaxhighlight>
*'''minWidth:''' An integer of the minimum width of the window.
*'''minHeight:''' An integer of the minimum height of the window.

===movable===
This is equivalent to [[dgsWindowSetMovable]], which allows you to specify whether or not a user can move a DGS window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"movable",movable)</syntaxhighlight>
*'''movable:''' A boolean value indicating whether user can move the window or not.

===sizable===
This is equivalent to [[dgsWindowSetSizable]], which allows you to specify whether or not a user can resize a DGS window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"sizable",sizable)</syntaxhighlight>
*'''movable:''' A boolean value indicating whether user can resize the window or not.

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(window,"text",text)</syntaxhighlight>
*'''text:''' A string of the title text of the window.

===textColor===
The color which can be translated by [[tocolor]] of the title text of the window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the title text of the window.

===textSize===
The scale of the '''title''' ''text'' of the window. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(window,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the title text of the window.
*'''scaleY:''' A float of the 2D Y scale of the title text of the window.

===titleColor===
The color which can be translated by [[tocolor]] of the '''title''' of the window when the window is '''focused''' ( For '''blurred''', see [[#titleColorBlur|titleColorBlur]] ).
<syntaxhighlight lang="lua">dgsSetProperty(window,"titleColor",titleColor)</syntaxhighlight>
*'''titleColor:''' An integer of the color of the title of the focused window.

===titleColorBlur===
The color which can be translated by [[tocolor]] of the title of the window when the window is '''blurred'''.
<syntaxhighlight lang="lua">dgsSetProperty(window,"titleColorBlur",titleColorBlur)</syntaxhighlight>
*'''titleColorBlur:''' An integer of the color of the title of the blurred window. Set to ''nil'' to disable blur color.

===titleHeight===
This property determines the title size in pixels which is also used to move the window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"titleHeight",titleHeight)</syntaxhighlight>
*'''titleHeight:''' An integer of the size of the title of the window in pixels.

===titleImage===
The texture element(texture/render target/screen source/shader etc) of the title background of the window.
<syntaxhighlight lang="lua">dgsSetProperty(window,"titleImage",titleImage)</syntaxhighlight>
*'''titleImage:''' A texture element of the title background of the window.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxswitchbutton

2022-03-16T17:27:11Z

Zhvachka: /* wordbreak */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxswitchbutton that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===clickType===
This property determines which button on mouse can change the state of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"clickType",clickType)</syntaxhighlight>
*'''clickType:''' An integer, available values are as follows:
**'''1:''' Left Mouse Button
**'''2:''' Wheel
**'''3:''' Right Mouse Button

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===cursorMoveSpeed===
This property determines the cursor moving speed when switch button changes state.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorMoveSpeed",cursorMoveSpeed)</syntaxhighlight>
*'''cursorMoveSpeed:''' A float of the cursor moving speed when switch button changes state.

===cursorWidth===
This property determines the cursor width of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorWidth",cursorWidth)</syntaxhighlight>
*'''cursorWidth:''' A float of the cursor width of switch button.

===cursorLength===
This property determines the cursor length of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorLength",cursorLength)</syntaxhighlight>
*'''cursorLength:''' A float of the cursor length of switch button.

===colorcoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"colorcoded",colorcoded)</syntaxhighlight>
*'''colorcoded:''' Set to true to enable embedded #FFFFFF color codes.

===colorOn===
The color which can be translated by [[tocolor]] of the background color when the switch button turns on.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"colorOn",{normalColor,hoverColor,clickColor})</syntaxhighlight>
*'''normalColor:''' A integer of background color of turned on switch button.
*'''hoverColor:''' A integer of background color of turned on switch button when the mouse is hovering on it.
*'''clickColor:''' A integer of background color of turned on switch button when the mouse is clicked on it.

===colorOff===
The color which can be translated by [[tocolor]] of the background color when the switch button turns off.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"colorOff",{normalColor,hoverColor,clickColor})</syntaxhighlight>
*'''normalColor:''' A integer of background color of turned off switch button.
*'''hoverColor:''' A integer of background color of turned off switch button when the mouse is hovering on it.
*'''clickColor:''' A integer of background color of turned off switch button when the mouse is clicked on it.

===cursorColor===
The color which can be translated by [[tocolor]] of the cursor color.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorColor",{normalColor,hoverColor,clickColor})</syntaxhighlight>
*'''normalColor:''' A integer of cursor color of the switch button.
*'''hoverColor:''' A integer of cursor color of the switch button when the mouse is hovering on it.
*'''clickColor:''' A integer of cursor color of the switch button when the mouse is clicked on it.

===cursorImage===
The cursor image of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorImage",{normalColor,hoverColor,clickColor})</syntaxhighlight>
*'''normalImage:''' An material of cursor image of the switch button.
*'''hoverImage:''' An material of cursor image of the switch button when the mouse is hovering on it.
*'''clickImage:''' An material of cursor image of the switch button when the mouse is clicked on it.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the switch button.

===imageOn===
The background image of switch button when the state is on.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"imageOn",{normalImage,hoverImage,clickImage})</syntaxhighlight>
*'''normalImage:''' An material of background image of turned on switch button.
*'''hoverImage:''' An material of background image of turned on switch button when the mouse is hovering on it.
*'''clickImage:''' An material of background image of turned on switch button when the mouse is clicked on it.

===imageOff===
The background image of switch button when the state is off.(
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"imageOff",{normalImage,hoverImage,clickImage})</syntaxhighlight>
*'''normalImage:''' An material of background image of turned off switch button.
*'''hoverImage:''' An material of background image of turned off switch button when the mouse is hovering on it.
*'''clickImage:''' An material of background image of turned off switch button when the mouse is clicked on it.

===shadow===
The shadow text of the switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the switch button.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the switch button.
*'''color:''' An integer of the color of the shadow text of the switch button.
*'''outline:''' A bool of the outline state of the shadow text.

===state===
This property indicates the state of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"state",state)</syntaxhighlight>
*'''state:''' A bool indicates the state of switch button.
**'''true:''' Turns on
**'''false:''' Turns off

===stateAnim===
This stores the progress of cursor animation, which is not recommend to modify.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"stateAnim",stateAnim)</syntaxhighlight>
*'''stateAnim:''' A float of the cursor animation progress.

===style===
This property determines the state of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"style",style)</syntaxhighlight>
*'''style:''' Mixed, available values are as follows:
**'''false:''' Default, a switch button with fading color when changing state.
**'''1:''' Split background color for turned on and off ( also split images ).
**'''2:''' Split background color for turned on and off ( not split images ).

===textOn===
This property stores the text to be shown when the switch button turns on.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textOn",textOn)</syntaxhighlight>
*'''textOn:''' A string of the text of the switch button.

===textOff===
This property stores the text to be shown when the switch button turns off.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textOff",textOff)</syntaxhighlight>
*'''textOff:''' A string of the text of the switch button.

===textColorOn===
The color which can be translated by [[tocolor]] of the text when the switch button turns on.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textColor_t",textColor_t)</syntaxhighlight>
*'''textColor_t:''' An integer of the color of the text when the switch button turns on.

===textColorOff===
The color which can be translated by [[tocolor]] of the text when the switch button turns off.(State=false)
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textColor_f",textColor_f)</syntaxhighlight>
*'''textColor_f:''' An integer of the color of the text when the switch button turns off.

===textSize===
The scale of the text of the switch button. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the switch button.
*'''scaleY:''' A float of the 2D Y scale of the text of the switch button.

===troughWidth===
This property determines trough length of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"troughWidth",troughWidth)</syntaxhighlight>
*'''troughWidth:''' A float of the trough length of switch button.

===wordbreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxscrollbar

2022-03-16T17:22:54Z

Zhvachka: /* map */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxscrollbar that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===arrowWidth===
This property adjusts the width of arrow ( take vertical scroll bar as a standard ).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"arrowWidth",{arrowWidth,relative})</syntaxhighlight>
*'''arrowWidth:''' A number of the width of arrow, which is affected by '''relative'''.
*'''relative:''' A bool of whether the width is relative or not. If this is true, then length must be between 0 and 1.

===arrowColor===
The arrow color of scroll bar, includes normal, hovering, click.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"arrowColor",{arrowColorNormal,arrowColorHover,arrowColorClick})</syntaxhighlight>
*'''arrowColorNormal:''' An integer of the arrow color, which can be converted by [[tocolor]].
*'''arrowColorHover:''' An integer of the arrow color when the mouse's cursor is hovering on it, which can be converted by [[tocolor]].
*'''arrowColorClick:''' An integer of the arrow color when the arrow gets clicked, which can be converted by [[tocolor]].

===arrowImage===
The arrow image of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"arrowImage",arrowImage)</syntaxhighlight>
*'''arrowImage:''' A material element of the arrow image of scroll bar.

===cursorColor===
The cursor color of scroll bar, includes normal, hovering, click.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"cursorColor",{cursorColorNormal,cursorColorHover,cursorColorClick})</syntaxhighlight>
*'''cursorColorNormal:''' An integer of the cursor color, which can be converted by [[tocolor]].
*'''cursorColorHover:''' An integer of the cursor color when the mouse's cursor is hovering on it, which can be converted by [[tocolor]].
*'''cursorColorClick:''' An integer of the cursor color when the cursor gets clicked, which can be converted by [[tocolor]].

===cursorImage===
The cursor image of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"cursorImage",cursorImage)</syntaxhighlight>
*'''cursorImage:''' A material element of the cursor image of scroll bar.

===cursorWidth===
This property adjusts the width of cursor ( take vertical scroll bar as a standard ).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"cursorWidth",{cursorWidth,relative})</syntaxhighlight>
*'''cursorWidth:''' A number of the width of arrow, which is affected by '''relative'''.
*'''relative:''' A bool of whether the width is relative or not. If this is true, then length must be between 0 and 1.

===grades===
This property stores the grades of scroll bar. ''See [[dgsScrollBarSetGrades]]/[[dgsScrollBarGetGrades]]''
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"grades",grades)</syntaxhighlight>
*'''grades:''' A number of the grades of scroll bar.

===currentGrade===
This property stores the current grade of scroll bar if ''grades'' enabled.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"currentGrade",currentGrade)</syntaxhighlight>
*'''currentGrade:''' A number of the current grade, ranges from 0 to ''grades''.

===image===
The image of scroll bar, includes arrow, cursor and trough.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"image",{arrowImage,cursorImage,troughImage})</syntaxhighlight>
*'''arrowImage:''' A texture of the image of arrow.
*'''cursorImage:''' A texture of the image of cursor.
*'''troughImage:''' A texture of the image of trough.

===imageRotation===
This property solves the problem of the rotation of the images.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"imageRotation",{Horizontal,Vertical})</syntaxhighlight>
*'''Horizontal:''' A table includes arrowImageRotation,cursorImageRotation,troughImageRotation of horizontal scroll bar, by default:
<syntaxhighlight lang="lua" >{0,270,270}</syntaxhighlight>
*'''Vertical:''' A table includes arrowImageRotation,cursorImageRotation,troughImageRotation of vertical scroll bar, by default:
<syntaxhighlight lang="lua" >{270,0,0}</syntaxhighlight>

===length===
This property determines whether the length of the cursor of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"length",{length,relative})</syntaxhighlight>
*'''length:''' A number of the length of scroll bar, which is affected by '''relative'''.
*'''relative:''' A bool of whether the length is relative or not. If this is true, then length must be between 0 and 1.

===locked===
This is equivalent to [[dgsScrollBarSetLocked]]/[[dgsScrollBarGetLocked]].
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"locked",locked)</syntaxhighlight>
*'''locked:''' A bool of whether the scroll bar get locked or not.

===map===
This property will map the value from 0~100 to mapMin~mapMax (Both get and set scroll position).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"map",{mapMin,mapMax})</syntaxhighlight>
*'''mapMin:''' A number of the min value.
*'''mapMax:''' A number of the max value.

===multiplier===
This property determines whether how much a scroll bar will scroll when you click the arrow or use mouse wheel.

This property is difficult to understand. Before use this property, do an experiment first.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"multiplier",{multiplier,relative})</syntaxhighlight>
*'''multiplier:''' A number of the multiplier of scroll bar, which is affected by '''relative'''.
*'''relative:''' A bool of whether the multiplier is relative or not. If this is true, then multiplier must be between 0 and 1.

===scrollPosition===
This is equivalent to [[dgsScrollBarSetScrollPosition]]/[[dgsScrollBarGetScrollPosition]].
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"scrollPosition",scrollPosition)</syntaxhighlight>
*'''scrollPosition:''' An integer of the scroll poisition of the scroll bar. Ranges from 0 to 100.

===scrollArrow===
This property indicates whether enable the scroll arrow or not. It is useful when making scroll bar act as slide or something else.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"scrollArrow",scrollArrow)</syntaxhighlight>
*'''scrollArrow:''' A bool of whether enable the scroll arrow or not.

===troughClickAction===
This property determines what will the scroll bar do when you click the trough.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughClickAction",troughClickAction)</syntaxhighlight>
*'''troughClickAction:''' A string. Available values are as follows:
**'''none:''' No actions.
**'''step:''' Step up or down.
**'''jump:''' Make cursor of scroll bar jump to the current place you click.

===troughColor===
The trough color of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughColor",{troughColorPart1,troughColorPart2})</syntaxhighlight>
*'''troughColorPart1:''' An integer of the trough color on the left/top side of the cursor, which can be converted by [[tocolor]].
*'''troughColorPart2:''' An integer of the trough color on the right/bottom side of the cursor, which can be converted by [[tocolor]].

===troughWidth===
This property adjusts the width of trough ( take vertical scroll bar as a standard ).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughWidth",{troughWidth,relative})</syntaxhighlight>
*'''troughWidth:''' A number of the width of arrow, which is affected by '''relative'''.
*'''relative:''' A bool of whether the width is relative or not. If this is true, then length must be between 0 and 1.

===troughImage===
The trough image of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughImage",troughImage)</syntaxhighlight>
*'''troughImage:''' A material element of the trough image of scroll bar.

===wheelReversed===
This property determines whether the increasing/decreasing direction is reversed when using mouse wheel.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"wheelReversed",wheelReversed)</syntaxhighlight>
*'''wheelReversed:''' A bool indicates whether the increasing/decreasing direction is reversed when using mouse wheel.

===isHorizontal===
This property determines whether the scroll bar is horizontal or vertical.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"isHorizontal",isHorizontal)</syntaxhighlight>
*'''isHorizontal:''' Available values are as follows:
**'''false:''' vertical
**'''true:''' horizontal

==See Also==
{{DGSPROPERTIES}}

Dgs-dxradiobutton

2022-03-16T17:20:54Z

Zhvachka: /* textPadding */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxradiobutton that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the text within the radiobutton.

The functions as follows are basic on this property.

[[dgsRadioButtonSetHorizontalAlign]]/[[dgsRadioButtonGetHorizontalAlign]]

[[dgsRadioButtonSetVerticalAlign]]/[[dgsRadioButtonGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(checkbx,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the radiobutton. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the radiobutton. Can be "top", "center" or "bottom".

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===color_f===
This property determines the color of the icon under 3 conditions when the radio button is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"color_f",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (unchecked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (unchecked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (unchecked)

===color_t===
This property determines the color of the icon under 3 conditions when the radio button is checked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"color_t",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (checked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (checked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (checked)

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the radiobutton.

===image_f===
This property determines the icon under 3 conditions when the radio button is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"image_f",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (unchecked)
*'''ImageHover:''' An image element of the icon under hovering state. (unchecked)
*'''ImageClick:''' An image element of the icon under clicked state. (unchecked)

===image_t===
This property determines the icon under 3 conditions when the radio button is checked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"image_t",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (checked)
*'''ImageHover:''' An image element of the icon under hovering state. (checked)
*'''ImageClick:''' An image element of the icon under clicked state. (checked)

===shadow===
The shadow text of the radiobutton.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the radiobutton.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the radiobutton.
*'''color:''' An integer of the color of the shadow text of the radiobutton.
*'''outline:''' A bool of the outline state of the shadow text.

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"text",text)</syntaxhighlight>
*'''text:''' A string of the text of the radiobutton.

===textColor===
The color which can be translated by [[tocolor]] of the text of the radiobutton.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the radiobutton.

===textPadding===
This property determines the padding between the text and icon.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textPadding",textPadding)</syntaxhighlight>
*'''textPadding:''' A float of the distance from the icon to the text of the radio button.

===textSize===
The scale of the text of the radiobutton. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the radiobutton.
*'''scaleY:''' A float of the 2D Y scale of the text of the radiobutton.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==Additional Property For Parent Element==
===RadioButton===
This property stores which radio button is selected.
<syntaxhighlight lang="lua">dgsSetProperty(parent,"RadioButton",RadioButton)</syntaxhighlight>
*'''RadioButton:''' The radio button that is selected.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxradiobutton

2022-03-16T17:20:20Z

Zhvachka: /* textPadding */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxradiobutton that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the text within the radiobutton.

The functions as follows are basic on this property.

[[dgsRadioButtonSetHorizontalAlign]]/[[dgsRadioButtonGetHorizontalAlign]]

[[dgsRadioButtonSetVerticalAlign]]/[[dgsRadioButtonGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(checkbx,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the radiobutton. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the radiobutton. Can be "top", "center" or "bottom".

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===color_f===
This property determines the color of the icon under 3 conditions when the radio button is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"color_f",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (unchecked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (unchecked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (unchecked)

===color_t===
This property determines the color of the icon under 3 conditions when the radio button is checked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"color_t",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (checked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (checked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (checked)

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the radiobutton.

===image_f===
This property determines the icon under 3 conditions when the radio button is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"image_f",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (unchecked)
*'''ImageHover:''' An image element of the icon under hovering state. (unchecked)
*'''ImageClick:''' An image element of the icon under clicked state. (unchecked)

===image_t===
This property determines the icon under 3 conditions when the radio button is checked.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"image_t",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (checked)
*'''ImageHover:''' An image element of the icon under hovering state. (checked)
*'''ImageClick:''' An image element of the icon under clicked state. (checked)

===shadow===
The shadow text of the radiobutton.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the radiobutton.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the radiobutton.
*'''color:''' An integer of the color of the shadow text of the radiobutton.
*'''outline:''' A bool of the outline state of the shadow text.

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"text",text)</syntaxhighlight>
*'''text:''' A string of the text of the radiobutton.

===textColor===
The color which can be translated by [[tocolor]] of the text of the radiobutton.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the radiobutton.

===textPadding===
This property determines the padding between the text and icon.
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textPadding",textPadding)</syntaxhighlight>
*'''textPadding''' A float of the distance from the icon to the text of the radio button.

===textSize===
The scale of the text of the radiobutton. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the radiobutton.
*'''scaleY:''' A float of the 2D Y scale of the text of the radiobutton.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(radiobutton,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==Additional Property For Parent Element==
===RadioButton===
This property stores which radio button is selected.
<syntaxhighlight lang="lua">dgsSetProperty(parent,"RadioButton",RadioButton)</syntaxhighlight>
*'''RadioButton:''' The radio button that is selected.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxprogressbar

2022-03-16T17:19:02Z

Zhvachka: /* thickness */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxlabel that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===bgColor===
This property determines the background color of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor''' : An integer of the color that can be converted by [[tocolor]].

===bgImage===
This property determines the background image of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage''' : A material element that serves as the background image of the progress bar (texture/shader/screen source/renderTarget).

===indicatorColor===
This property determines the indicator color of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"indicatorColor",indicatorColor)</syntaxhighlight>
*'''indicatorColor''' : An integer of the color that can be converted by [[tocolor]].

===indicatorImage===
This property determines the indicator image of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"indicatorImage",indicatorImage)</syntaxhighlight>
*'''indicatorImage''' : A material element that serves as the indicator image of the progress bar (texture/shader/screen source/renderTarget).

===padding===
This property determines the padding of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"padding",{paddingX,paddingY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===progress===
This property stores the progress value of progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"progress",progress)</syntaxhighlight>
*'''progress''' : A float of progress value.

===style===
This property stores the style name of progress bar, to change the style use [[dgsProgressBarSetStyle]].
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"style",style)</syntaxhighlight>
*'''style''' : A string of the style name.

==Style Properties==
===>Style:normal-horizontal<===
None
===>Style:normal-vertical<===
None
===>Style:ring-round<===
====elements====
This style property stores the custom elements of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"elements",elements)</syntaxhighlight>
*'''elements:''' A table of elements. Built-in elements are as follows:
**'''elements.circleShader:''' A shader of ring-round style.

====isClockwise====
This style property determines whether the progress direction is clockwise or anti-clockwise .
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"isClockwise",isClockwise)</syntaxhighlight>
*'''isClockwise:''' A bool of whether the progress direction is clockwise or anti-clockwise.

====rotation====
This style property determines the rotation of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"rotation",rotation)</syntaxhighlight>
*'''rotation:''' A float of the rotation of the ring.

====antiAliased====
This style property determines the anti aliasing of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"antiAliased",antiAliased)</syntaxhighlight>
*'''antiAliased:''' A float of the anti aliasing of the ring.

====radius====
This style property determines the radius of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"radius",radius)</syntaxhighlight>
*'''radius:''' A float of the radius of the ring.

====thickness====
This style property determines the thickness of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"thickness",thickness)</syntaxhighlight>
*'''radius:''' A float of the thickness of the ring.

===>Style:ring-plain<===
====elements====
This style property stores the custom elements of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"elements",elements)</syntaxhighlight>
*'''elements:''' A table of elements. Built-in elements are as follows:
**'''elements.circleShader:''' A shader of ring-round style.

====isClockwise====
This style property determines whether the progress direction is clockwise or anti-clockwise.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"isClockwise",isClockwise)</syntaxhighlight>
*'''isClockwise:''' A bool of whether the progress direction is clockwise or anti-clockwise.

====rotation====
This style property determines the rotation of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"rotation",rotation)</syntaxhighlight>
*'''rotation:''' A float of the rotation of the ring.

====antiAliased====
This style property determines the anti aliasing of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"antiAliased",antiAliased)</syntaxhighlight>
*'''antiAliased:''' A float of the anti aliasing of the ring.

====radius====
This style property determines the radius of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"radius",radius)</syntaxhighlight>
*'''radius:''' A float of the radius of the ring.

====thickness====
This style property determines the thickness of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"thickness",thickness)</syntaxhighlight>
*'''thickness:''' A float of the thickness of the ring.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxgridlist

2022-03-16T17:11:01Z

Zhvachka: /* columnImage */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxgridlist that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===autoSort===
This property determines whether auto sort is enabled. ''See [[dgsGridListSetAutoSortEnabled]]/[[dgsGridListGetAutoSortEnabled]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"autoSort",autoSort)</syntaxhighlight>
*'''autoSort:''' A bool of auto sort state.

===backgroundOffset===
This property determines the offset between the left border and row background.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"backgroundOffset",backgroundOffset)</syntaxhighlight>
*'''backgroundOffset:''' An integer of the offset between the left border and row background.

===bgColor===
This property determines the background color of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor:''' An integer of the color that can be converted by [[tocolor]].

===bgImage===
This property determines the background image of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage:''' A material element that serves as the background image of the grid list (texture/shader/screen source/renderTarget).

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===columnColor===
This property determines the background color of the column of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnColor",columnColor)</syntaxhighlight>
*'''columnColor:''' An integer of the color that can be converted by [[tocolor]].

===columnData===
This property stores column data.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnData",columnData)</syntaxhighlight>
*'''columnData:''' A table stores all column data.
'''Data Structure'''
<syntaxhighlight lang="lua">
{
{ text, Width, AllWidthFront, Alignment, color, colorcoded, sizeX, sizeY, font },
{ text, Width, AllWidthFront, Alignment, color, colorcoded, sizeX, sizeY, font },
{ text, Width, AllWidthFront, Alignment, color, colorcoded, sizeX, sizeY, font },
...
}
</syntaxhighlight>

===columnHeight===
This property determines the column height of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnHeight",columnHeight)</syntaxhighlight>
*'''columnHeight:''' An integer of column height of the grid list.

===columnImage===
This property determines the background image of the column of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnImage",columnImage)</syntaxhighlight>
*'''columnImage:''' A material element that serves as the background image of the column of the grid list (texture/shader/screen source/renderTarget).

===columnMoveOffset===
This property stores the move offset of column that is used to render.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnMoveOffset",columnMoveOffset)</syntaxhighlight>
*'''columnMoveOffset:''' A float stores the move offset of column that is used to render.

===columnOffset===
This property determines the global offset between the left border and column text.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnOffset",columnOffset)</syntaxhighlight>
*'''columnOffset:''' An integer of offset of the column.

===columnRelative===
This property determines whether the column length is relative or not. ''See [[dgsGridListSetColumnRelative]]/[[dgsGridListGetColumnRelative]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnRelative",columnRelative)</syntaxhighlight>
*'''columnRelative:''' A bool of the relative state of the column length.

===columnShadow===
The shadow text of the column.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnShadow",{offsetX,offsetY,color})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the column.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the column.
*'''color:''' An integer of the color of the shadow text of the column.

===columnTextColor===
This property determines the color of the column text of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnTextColor",columnTextColor)</syntaxhighlight>
*'''columnTextColor:''' An integer of the color that can be converted by [[tocolor]].

===columnTextPosOffset===
This property adjusts the offset of the text of the column, which can solve text misplacing caused by font.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnTextPosOffset",{offsetX,offsetY})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the text of the column.
*'''offsetY:''' A float of the 2D Y offset of the text of the column.

===columnTextSize===
This property determines the scale of the column text of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnTextSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the column.
*'''scaleY:''' A float of the 2D Y scale of the text of the column.

===columnWordBreak===
This property determines whether word break property for column is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnWordBreak",columnWordBreak)</syntaxhighlight>
*'''columnWordBreak:''' A bool indicates whether the word break is enabled.

===colorcoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"colorcoded",colorcoded)</syntaxhighlight>
*'''colorcoded:''' Set to true to enable embedded #FFFFFF color codes.

===defaultColumnOffset===
This property determines offset of normal row column (is different from but works with columnOffset). ''See [[dgsGridListSetRowAsSection]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"defaultColumnOffset",defaultColumnOffset)</syntaxhighlight>
*'''defaultColumnOffset:''' An integer of the offset of normal row column.

===defaultSortFunctions===
This property determines the default sort function of grid list when clicking column.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"defaultSortFunctions",{lowerSortFunction,upperSortFunction})</syntaxhighlight>
*'''lowerSortFunction:''' A string of the lower sort function name.
*'''upperSortFunction:''' A string of the upper sort function name.
Here are three groups can be use:
*'''greaterLower'''/'''greaterUpper''': Sorting directly with string.
*'''numGreaterLowerNumFirst'''/'''numGreaterUpperNumFirst''': Sorting support number order with number first.
*'''numGreaterLowerStrFirst'''/'''numGreaterUpperStrFirst''': Sorting support number order with string first.
*'''longerLower'''/'''longerUpper''': Sorting according to the utf8 length of the string.

===defaultSortIcons===
This property determines the icons of the default sort function.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"defaultSortIcons",{iconA,iconB})</syntaxhighlight>
*'''iconA:''' A string of the lower sort icon ('''▲''' By default).
*'''iconB:''' A string of the upper sort icon ('''▼''' By default).

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"font",font)</syntaxhighlight>
*'''font:''' A [[Element/DX_font|dx font element]] of the default text font of the gridlist.

===leading===
This property determines the space between rows.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"leading",leading)</syntaxhighlight>
*'''leading:''' How many pixels between rows

===multiSelection===
This property determines whether multi selection is enabled or not. ''See [[dgsGridListSetMultiSelectionEnabled]]/[[dgsGridListGetMultiSelectionEnabled]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"multiSelection",multiSelection)</syntaxhighlight>
*'''multiSelection:''' A bool of the state of the multi selection.

===mode===
This property determines the render mode of grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"mode",mode)</syntaxhighlight>
*'''mode:''' A bool of the state of render mode. Detail:
**'''true:''' No render target mode (Crappy and have a lot of bugs but doesn't take video memory)
**'''false:''' Render target mode (Great quality but takes video memory)

===mouseSelectButton ===
This property allows which button on the mouse can select items of grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"mouseSelectButton",{canLeftButton,canMiddleButton,canRightButton})</syntaxhighlight>
*'''canLeftButton:''' A bool of whether left mouse button can select the grid list (default is true)
*'''canMiddleButton:''' A bool of whether middle mouse button can select the grid list (default is false)
*'''canRightButton:''' A bool of whether right mouse button can select the grid list (default is false)

===moveHardness===
This property determines how hard will the grid list moves when scrolling.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"moveHardness",{scrollHardness,dragHardness})</syntaxhighlight>
*'''scrollHardness:''' A float determins how hard will the grid list moves when scrolling with wheel ( should be larger than 0, lower than 1 ).
*'''dragHardness:''' A float determins how hard will the grid list moves when dragging with mouse ( should be larger than 0, lower than 1 ).

===preSelect===
This property stores the item id the cursor is hovering on.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"preSelect",{rowIndex,columnIndex})</syntaxhighlight>
*'''rowIndex:''' Row Index
*'''columnIndex:''' Column Index

===rowColor===
This property determines the default 3 states' colors of row. ''See [[dgsGridListSetRowBackGroundColor]]/[[dgsGridListGetRowBackGroundColor]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowColor",{colorDefault,colorHoving,colorSelected})</syntaxhighlight>
*'''colorDefault:''' An integer of the color of the row (Default State).
*'''colorHoving:''' An integer of the color of the row (Hoving State).
*'''colorSelected:''' An integer of the color of the row (Selected State).

===rowData===
This property stores row data.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowData",rowData)</syntaxhighlight>
*'''rowData:''' A table stores all row data.
'''Data Structure'''
<syntaxhighlight lang="lua">
{

[1] = {
[-4] = columnOffset, --column offset
[-3] = {normal,hovering,selected}, --background image
[-2] = true/false, --selectable
[-1] = true/false, --clickable
[0] = {normal,hovering,selected}, --background color
[1] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable}, --Column 1
[2] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable}, --Column 2
...
}, --Row 1
[2] = {
[-4] = columnOffset, --column offset
[-3] = {normal,hovering,selected}, --background image
[-2] = true/false, --selectable
[-1] = true/false, --clickable
[0] = {normal,hovering,selected}, --background color
[1] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable}, --Column 1
[2] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable}, --Column 2
...
}, --Row 2
}
</syntaxhighlight>

===rowHeight===
This property determines the row height of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowHeight",rowHeight)</syntaxhighlight>
*'''rowHeight:''' An integer of row height of the grid list.

===rowImage===
This property determines the default 3 states' background image of row. ''See [[dgsGridListGetRowBackGroundImage]]/[[dgsGridListSetRowBackGroundImage]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowImage",{normalImage,hoveringImage,selectedImage})</syntaxhighlight>
*'''normalImage:''' A texture of the image of the row (Normal State).
*'''hoveringImage:''' A texture of the image of the row (Hoving State).
*'''selectedImage:''' A texture of the image of the row (Selected State).

===rowMoveOffset===
This property stores the move offset of row that is used to render.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowMoveOffset",rowMoveOffset)</syntaxhighlight>
*'''rowMoveOffset:''' A float stores the move offset of row that is used to render.

===rowSelect===
This property stores the selected rows.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowSelect",data)</syntaxhighlight>
*'''data:''' the data.
'''Data Structure'''
<syntaxhighlight lang="lua">
{
[Column1] = {
Row1,
Row2,
...
},
[Column2] = {
Row1,
Row2,
...
},
...
}
</syntaxhighlight>

===rowShadow===
The shadow text of the row.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowShadow",{offsetX,offsetY,color})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the row.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the row.
*'''color:''' An integer of the color of the shadow text of the row.

===rowTextColor===
This property determines the default color of the row text of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowTextColor",rowTextColor)</syntaxhighlight>
*'''rowTextColor:''' An integer of the color of the row text that can be converted by [[tocolor]].

<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowTextColor",{normalColor,hoveringColor,selectedColor})</syntaxhighlight>
*'''normalColor:''' A integer of the color of the row text that can be converted by [[tocolor]](Normal State).
*'''hoveringColor:''' A integer of the color of the row text that can be converted by [[tocolor]](Hoving State).
*'''selectedColor:''' A integer of the color of the row text that can be converted by [[tocolor]](Selected State).

===rowTextPosOffset===
This property adjusts the offset of the text of the row, which can solve text misplacing caused by font.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowTextPosOffset",{offsetX,offsetY})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the text of the row.
*'''offsetY:''' A float of the 2D Y offset of the text of the row.

===rowTextSize===
This property determines the default scale of the row text of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowTextSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the row.
*'''scaleY:''' A float of the 2D Y scale of the text of the row.

===rowWordBreak===
This property determines whether word break property for row is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowWordBreak",rowWordBreak)</syntaxhighlight>
*'''rowWordBreak:''' A bool indicates whether the word break is enabled.

===scrollBarState===
This property forces the visibility of scroll bar. ''See [[dgsGridListSetScrollBarState]]/[[dgsGridListGetScrollBarState]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"scrollBarState",{vertical,horizontal})</syntaxhighlight>
*'''vertical:''' A bool of the state of the vertical scroll bar.
*'''horizontal:''' A bool of the state of the horizontal scroll bar.
**'''true:''' Force to be visible
**'''false:''' Force to be invisible
**'''nil:''' Auto

===scrollBarThick===
This property determines the thickness of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"scrollBarThick",scrollBarThick)</syntaxhighlight>
*'''scrollBarThick:''' An integer of the thickness of scroll bar.

===sectionColumnOffset===
This property determines offset of section row column (is different from but works with columnOffset). ''See [[dgsGridListSetRowAsSection]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"sectionColumnOffset",sectionColumnOffset)</syntaxhighlight>
*'''sectionColumnOffset:''' An integer of the offset of section row column.

===sectionFont===
This property determines the font of the text of which row is in section mode. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"sectionFont",sectionFont)</syntaxhighlight>
*'''sectionFont:''' A [[Element/DX_font|dx font element]] of the text of which row is in section mode.

===selectionMode===
This property stores current selection mode of grid list. ''See [[dgsGridListSetSelectionMode]]/[[dgsGridListGetSelectionMode]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"selectionMode",selectionMode)</syntaxhighlight>
*'''selectionMode:''' The mode of the selection. Can be the following values:
**'''1:''' row selection
**'''2:''' column selection
**'''3:''' cell selection

===selectedColumn===
This property stores the index of which column the cursor is hovering. ''See [[dgsGridListGetEnterColumn]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"selectedColumn",selectedColumn)</syntaxhighlight>
*'''columnHeight:''' Column Index.

===sortColumn===
This property determines target sort column. ''See [[dgsGridListSetSortColumn]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"sortColumn",sortColumn)</syntaxhighlight>
*'''sortColumn:''' An integer of the specific column to be sorted by.

===sortEnabled===
This property determines whether sort is enabled. ''See [[dgsGridListSetSortEnabled]]/[[dgsGridListGetSortEnabled]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"sortEnabled",sortEnabled)</syntaxhighlight>
*'''sortEnabled:''' A bool of sort state.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxedit

2022-03-16T17:08:07Z

Zhvachka: /* caretStyle */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxedit that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the text within the edit.

The functions as follows are basic on this property.

[[dgsEditSetHorizontalAlign]]/[[dgsEditGetHorizontalAlign]]

[[dgsEditSetVerticalAlign]]/[[dgsEditGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX''' : Horizontal alignment of the text within the edit. Can be "left", "center" or "right".
*'''alignY''' : Vertical alignment of the text within the edit. Can be "top", "center" or "bottom".

===allowCopy===
This propertry determines whether the text can be copyed ( ctrl+c ) or cut ( ctrl+x )
<syntaxhighlight lang="lua">dgsSetProperty(edit,"allowCopy",allowCopy)</syntaxhighlight>
*'''allowCopy''' : A bool indicates whether the text can be copyed ( ctrl+c ) or cut ( ctrl+x )

===autoComplete===
This propertry allows auto complete for edit. ''See'' [[dgsEditAddAutoComplete]]\[[dgsEditRemoveAutoComplete]]\[[dgsEditSetAutoComplete]]\[[dgsEditGetAutoComplete]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"autoComplete",autoComplete)</syntaxhighlight>
*'''autoComplete''' : The auto complete table. Structure is as follows:
<syntaxhighlight lang="lua">
autoComplete = {
name1 = isSensitive,
name2 = isSensitive,
}
</syntaxhighlight>

===autoCompleteSkip===
This propertry allows skip auto complete detect.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"autoCompleteSkip",autoCompleteSkip)</syntaxhighlight>
*'''autoCompleteSkip''' : A bool if whether disabling auto complete check

===autoCompleteShow===
This propertry stores current showing auto complete item.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"autoCompleteShow",autoCompleteShow)</syntaxhighlight>
*'''autoCompleteShow''' : A table stores the showing data. Structure is as follows:
<syntaxhighlight lang="lua">
autoCompleteShow = {matchedAutoCompletion,showingAutoCompletion}
</syntaxhighlight>

===bgColor===
This property determines the background color of the edit.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor''' : An integer of the color that can be converted by [[tocolor]].

===bgColorBlur===
This property determines the background color of the edit when it is blurred.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"bgColorBlur",bgColorBlur)</syntaxhighlight>
*'''bgColorBlur:''' An integer of the color that can be converted by [[tocolor]], leave to nil to use bgImage.

===bgImage===
This property determines the background image of the edit.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage''' : A material element that serves as the background image of the edit (texture/shader/screen source/renderTarget).

===bgImageBlur===
This property determines the background image of the edit when it is blurred.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"bgImageBlur",bgImageBlur)</syntaxhighlight>
*'''bgImageBlur:''' A material element that serves as the background image of the edit(texture/shader/screen source/renderTarget), leave to nil to use bgImage.

===caretColor===
This property determines the color of the caret
<syntaxhighlight lang="lua">dgsSetProperty(edit,"caretColor",caretColor)</syntaxhighlight>
*'''caretColor''' : An integer of the color that can be converted by [[tocolor]].

===caretHeight===
This property determines what's the height of the caret.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"caretHeight",caretHeight)</syntaxhighlight>
*'''caretHeight''' : A float indicates what's the height of the caret.

===caretOffset===
The offset of the caret of the edit.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"caretOffset",offset)</syntaxhighlight>
*'''offset''' : A float of the offset of the caret of the edit.

===caretPos===
The position where the caret stays.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"caretPos",index)</syntaxhighlight>
*'''index''' : An integer of the index of the text that the caret stays.

===clearSelection===
This property determines whether the text selection will be cleared when the edit blurs.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"clearSelection",clearSelection)</syntaxhighlight>
*'''clearSelection''' : A bool indicates whether the text selection will be cleared when the edit blurs.

===caretStyle===
This is equivalent to [[dgsEditSetCaretStyle]]/[[dgsEditGetCaretStyle]].

This property allows us to change the style of caret of the edit. ( 0 is "|"; 1 is "_" )

Example(0):

This is Text|

Example(1):

This is Text_
<syntaxhighlight lang="lua">dgsSetProperty(edit,"caretStyle",caretStyle)</syntaxhighlight>
*'''caretStyle''' : An integer of the caret style of the edit.

===caretThick===
This property allows us to change the thickness of caret of the edit.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"caretThick",caretThick)</syntaxhighlight>
*'''caretThick''' : An integer of the thickness of the caret of the edit.

===caretWidth===
This property allows us to change the caret width in caretStyle '''"1"'''.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"caretWidth",{caretWidth,caretDefaultWidth,relative})</syntaxhighlight>
*'''caretWidth''' : A float of the width of the caret of the edit. If '''relative''' is ''true'', this will refer to font width of a character.
*'''caretDefaultWidth''' : A float of the width of the caret of the edit when there is no text to refer. If '''relative''' is '''true''', this will refer to '''textSize'''.
*'''relative''' : A bool indicates whether caret width is relative or absolute.

===edit===
This property stores a gui-edit which is used to input characters.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"edit",gedit)</syntaxhighlight>
*'''gedit''' : A gui-edit.

===enableTabSwitch===
This property determines whether we can use the key "tab" to switch to another edit.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"enableTabSwitch",enableTabSwitch)</syntaxhighlight>
*'''enableTabSwitch''' : A bool indicates whether we can use the key ''tab'' to switch to another edit.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(edit,"font",font)</syntaxhighlight>
*'''font''' : A [[Element/DX_font|dx font element]] of the text font of the edit.

===masked===
This is equivalent to [[dgsEditSetMasked]]/[[dgsEditGetMasked]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"masked",masked)</syntaxhighlight>
*'''masked''' : A boolean value indicating whether masking is to be enabled or disabled.

===maskText===
This property determines what the masked text will be, and the default is "*".
<syntaxhighlight lang="lua">dgsSetProperty(edit,"maskText",maskText)</syntaxhighlight>
*'''maskText''' : A string that the masked text will be.

===maxLength===
This is equivalent to [[dgsEditGetMaxLength]]/[[dgsEditSetMaxLength]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"maxLength",maxLength)</syntaxhighlight>
*'''maxLength''' : An integer indicating the maximum number of characters that can be typed into the edit box.

===padding===
This property determines the padding of the text.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"padding",{paddingX,paddingY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===placeHolder===
This is equivalent to [[dgsEditSetPlaceHolder]]//[[dgsEditGetPlaceHolder]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolder",placeHolder)</syntaxhighlight>
*'''placeHolder''' : A string of the place holder text of dgs edit ( This text will show when there is no text in a blurred dgs edit ).

===placeHolderColor===
This property determines the color of the place holder text. The color which can be translated by [[tocolor]].
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderColor",placeHolderColor)</syntaxhighlight>
*'''placeHolderColor''' : An integer of the color of the place holder text of the edit.

===placeHolderColorcoded===
This property determines whether the place holder supports color code.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderColorcoded",placeHolderColorcoded)</syntaxhighlight>
*'''placeHolderColorcoded''' : A bool indicates whether the place holder supports color code.

===placeHolderFont===
This property changes the font of place holder.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderFont",placeHolderFont)</syntaxhighlight>
*'''placeHolderFont''' : A string/dx-font element of the font of the place holder.

===placeHolderIgnoreRenderTarget===
This property determines whether the place holder isn't restricted by render target.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderIgnoreRenderTarget",placeHolderIgnoreRenderTarget)</syntaxhighlight>
*'''placeHolderIgnoreRenderTarget''' : A bool indicates whether the place holder isn't restricted by render target.

===placeHolderOffset===
This property allows place holder has offsets relative to its original position.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderOffset",{ xOffset, yOffset })</syntaxhighlight>
*'''xOffset''' : An integer of 2D x offset.
*'''yOffset''' : An integer of 2D y offset.

===placeHolderVisibleWhenFocus===
This property allows place holder to be visible even when edit is focused.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderVisibleWhenFocus",placeHolderVisibleWhenFocus)</syntaxhighlight>
*'''placeHolderVisibleWhenFocus''' : A bool indicates whether the place holder when the edit is focused.

===readOnly===
This is equivalent to [[dgsEditSetReadOnly]]/[[dgsEditGetReadOnly]].
<syntaxhighlight lang="lua">dgsSetProperty(edit,"readOnly",readOnly)</syntaxhighlight>
*'''readOnly''' : A bool indicates whether the edit is only readable.

===readOnlyCaretShow===
Whether the caret of edit will show/hide under read-only mode.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"readOnlyCaretShow",readOnlyCaretShow)</syntaxhighlight>
*'''readOnlyCaretShow''' : A bool indicates whether the caret is shown or hidden when the edit is read-only.

===renderTarget===
This property stores a render target of the edit.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"renderTarget",renderTarget)</syntaxhighlight>
*'''renderTarget''' : A render target that is used to render the text.

===selectColorBlur===
The color which can be translated by [[tocolor]] of the rectangle of text selection of the edit when blurred.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"selectColorBlur",selectColorBlur)</syntaxhighlight>
*'''selectColorBlur''' : An integer of the color of the rectangle of text selection of the edit when blurred.

===selectColor===
The color which can be translated by [[tocolor]] of the rectangle of text selection of the edit.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"selectColor",selectColor)</syntaxhighlight>
*'''selectColor''' : An integer of the color of the rectangle of text selection of the edit.

===selectFrom===
The position from which the text is selected.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"selectFrom",{index,line})</syntaxhighlight>
*'''index''' : An integer of the index of the text that selected from.

===showPos===
The min value of the x position of the text of the edit starts to show in the render target. ( I don't know how to explain it. XD )
<syntaxhighlight lang="lua">dgsSetProperty(edit,"showPos",posX)</syntaxhighlight>
*'''posX''' : An integer indicates how many pixels of the text are moved to left.

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(edit,"text",text)</syntaxhighlight>
*'''text''' : A ''table'' of the text of the edit.( Because of multi lines, I use table instead of string )

===textColor===
The color which can be translated by [[tocolor]] of the text of the edit.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"textColor",textColor)</syntaxhighlight>
*'''textColor''' : An integer of the color of the text of the edit.

===textSize===
The scale of the text of the edit. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(edit,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX''' : A float of the 2D X scale of the text of the edit.
*'''scaleY''' : A float of the 2D Y scale of the text of the edit.

===typingSound===
Typing sound, nil for disabled. This is equivalent to [[dgsEditSetTypingSound]]/[[dgsEditGetTypingSound]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"typingSound",typingSound)</syntaxhighlight>
*'''typingSound:''' A string of the path/url of typing sound.

===typingSoundVolume===
Typing sound, nil for disabled. This is equivalent to [[dgsEditSetTypingSoundVolume]]/[[dgsEditGetTypingSoundVolume]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"typingSoundVolume",typingSoundVolume)</syntaxhighlight>
*'''typingSoundVolume:''' A float of the volume of the typing sound. Range is from 0.0 to 1.0. This can go above 1.0 for amplification.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxcombobox

2022-03-16T17:05:04Z

Zhvachka: /* wordbreak */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxcombobox that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===arrow===
This property determines the arrow material of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"arrow",arrow)</syntaxhighlight>
*'''arrow:''' A material element (texture/shader/screen).

===alignment===
Alignment of the caption text within the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the caption text within the combo box. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the caption text within the combo box. Can be "top", "center" or "bottom".

===autoHideAfterSelected===
This property determines whether the drop down will be hide automatically after selected.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"autoHideAfterSelected",autoHideAfterSelected)</syntaxhighlight>
*'''autoHideAfterSelected:''' A bool indicates whether the drop down will be hide automatically after selected.

===autoSort===
This property determines whether auto sort is enabled. ''See [[dgsComboBoxSetAutoSortEnabled]]/[[dgsComboBoxGetAutoSortEnabled]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"autoSort",autoSort)</syntaxhighlight>
*'''autoSort:''' A bool of auto sort state.

===bgColor===
This property determines the background color of the combo box (behind items).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor:''' An integer of the color that can be converted by [[tocolor]].

===bgImage===
This property determines the background image of the combo box (behind items).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage:''' A material element that serves as the background image of the combo box (texture/shader/screen source/renderTarget).

===buttonLen===
This property stores the width of the arrow button.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"buttonLen",{buttonLen,relative})</syntaxhighlight>
*'''buttonLen:''' A float of the width of arrow button, which is affected by '''relative'''.
*'''relative:''' If set to ''true'', '''buttonLen''' will range from 0 to 1 relative to combo box's height, otherwise the '''buttonLen''' will be absolute pixels.

===captionEdit===
This property stores the caption edit when the caption is editable with [[dgsComboBoxSetEditEnabled]].
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"captionEdit",captionEdit)</syntaxhighlight>
*'''captionEdit:''' A dgs-dxedit element.

===caption===
This property stores the caption text of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"caption",caption)</syntaxhighlight>
*'''caption:''' A string of the caption text of the combo box.

===clip===
Whether the clip property is enabled (include caption text and item text). ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===color===
The color which can be translated by [[tocolor]] of the background of the combobox (behind arrow).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"color",{normalColor,hoveringColor,clickedColor})</syntaxhighlight>
*'''normalColor:''' An integer of the color of the combobox ( neither selected nor clicked by mouse ).
*'''hoveringColor:''' An integer of the color of the combobox which is selected.
*'''clickedColor:''' An integer of the color of the comboox which is clicked.

===colorcoded===
Whether the color code is enabled (include caption text and item text). ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"colorcoded",colorcoded)</syntaxhighlight>
*'''colorcoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the combo box.

===scrollBarThick===
This property determines the thickness of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"scrollBarThick",scrollBarThick)</syntaxhighlight>
*'''scrollBarThick:''' An integer of the thickness of scroll bar.

===shadow===
The shadow of the text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the combo box.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the combo box.
*'''color:''' An integer of the color of the shadow text of the combo box.
*'''outline:''' A bool of the outline state of the shadow text.

===myBox===
Combo box is composed by dgs-dxcombobox and dgs-dxcombobox-Box. This property stores the dgs-combobox-Box of dgs-dxcombobox.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"myBox",myBox)</syntaxhighlight>
*'''myBox:''' A dgs-dxcombobox-box element.

===image===
The image of combo box ( under arrow ).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"image",{normalImage,hoveringImage,clickedImage})</syntaxhighlight>
*'''normalImage:''' A texture element of the background of the combobox ( no mouse enter and no mouse click ).
*'''hoveringImage:''' A texture element of the background of the combobox which is selected.
*'''clickedImage:''' A texture element of the background of the combobox which is clicked.

===itemAlignment===
Alignment of the item text within the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemAlignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the item text within the combo box. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the item text within the combo box. Can be "top", "center" or "bottom".

===itemTextPadding===
This property determines the item text padding of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextPadding",{paddingX,paddingY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===itemColor===
This property determines the 3 states' back ground colors of item.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemColor",{colorNormal,colorHoving,colorSelected})</syntaxhighlight>
*'''colorNormal:''' An integer of the color of the item (Normal State).
*'''colorHoving:''' An integer of the color of the item (Hoving State).
*'''colorSelected:''' An integer of the color of the item (Selected State).

===itemData===
This property stores item data.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"itemData",itemData)</syntaxhighlight>
*'''columnData:''' A table stores all item data.
'''Item Structure'''
<syntaxhighlight lang="lua">
{
textColor BackGround Image BackGround Color Text
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{ ... },
}
]]
</syntaxhighlight>

===itemImage===
This property determines the 3 states' background image of item.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemImage",{imageNormal,imageHoving,imageSelected})</syntaxhighlight>
*'''imageNormal:''' A texture of the image of the row (Normal State).
*'''imageHoving:''' A texture of the image of the row (Hoving State).
*'''imageSelected:''' A texture of the image of the row (Selected State).

===itemMoveOffset===
This property stores the move offset of item that is used to render.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemMoveOffset",itemMoveOffset)</syntaxhighlight>
*'''itemMoveOffset:''' A float stores the move offset of item that is used to render.

===itemTextColor===
This property determines the color of the item text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextColor",itemTextColor)</syntaxhighlight>
*'''itemTextColor:''' An integer of the color that can be converted by [[tocolor]].

===itemTextSize===
This property determines the scale of the item text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the item.
*'''scaleY:''' A float of the 2D Y scale of the text of the item.

===listState===
This property stores the state of combo box which determines whether the combo box is opened(1) or closed(-1).
See: [[dgsComboBoxGetState]]/[[dgsComboBoxSetState]]
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"listState",listState)</syntaxhighlight>
*'''listState:''' An integer of the state of combo box.

===moveHardness===
This property determines how hard will the combo box moves when scrolling.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"moveHardness",moveHardness)</syntaxhighlight>
*'''moveHardness:''' A float determins how hard will the combo box moves when scrolling ( should be larger than 0, lower than 1 ).

===scrollbar===
This property stores the scroll bar of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"scrollbar",scrollbar)</syntaxhighlight>
*'''scrollbar:''' a dgs-dxscrollbar element.

===select===
This property stores the selected item of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"select",select)</syntaxhighlight>
*'''select:''' A integer of the index of selected item .

===textColor===
The color which can be translated by [[tocolor]] of the caption text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the combo box.

===textPadding===
This property determines the caption text padding of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textPadding",{paddingX,paddingY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===textSize===
The scale of the capiton text of the combo box. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the combo box.
*'''scaleY:''' A float of the 2D Y scale of the text of the combo box.

===textBox===
This property determines whether the '''caption''' of combo box is enabled or not.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textBox",textBox)</syntaxhighlight>
*'''textBox:''' A bool indicates whether the '''caption''' of combo box is enabled or not.

===wordbreak===
Whether the word-break of capiton text is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(capiton ,"wordBreak",wordbreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==Property of dgs-dxcombobox-Box==
===myCombo===
Combo box is composed by dgs-dxcombobox and dgs-dxcombobox-Box. This property stores the dgs-combobox of dgs-dxcombobox-Box.
<syntaxhighlight lang="lua">dgsSetProperty(myCombo,"myCombo",myCombo)</syntaxhighlight>
*'''myComboyBox:''' A dgs-dxcombobox element.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxcombobox

2022-03-16T17:04:15Z

Zhvachka: /* textPadding */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxcombobox that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===arrow===
This property determines the arrow material of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"arrow",arrow)</syntaxhighlight>
*'''arrow:''' A material element (texture/shader/screen).

===alignment===
Alignment of the caption text within the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the caption text within the combo box. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the caption text within the combo box. Can be "top", "center" or "bottom".

===autoHideAfterSelected===
This property determines whether the drop down will be hide automatically after selected.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"autoHideAfterSelected",autoHideAfterSelected)</syntaxhighlight>
*'''autoHideAfterSelected:''' A bool indicates whether the drop down will be hide automatically after selected.

===autoSort===
This property determines whether auto sort is enabled. ''See [[dgsComboBoxSetAutoSortEnabled]]/[[dgsComboBoxGetAutoSortEnabled]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"autoSort",autoSort)</syntaxhighlight>
*'''autoSort:''' A bool of auto sort state.

===bgColor===
This property determines the background color of the combo box (behind items).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor:''' An integer of the color that can be converted by [[tocolor]].

===bgImage===
This property determines the background image of the combo box (behind items).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage:''' A material element that serves as the background image of the combo box (texture/shader/screen source/renderTarget).

===buttonLen===
This property stores the width of the arrow button.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"buttonLen",{buttonLen,relative})</syntaxhighlight>
*'''buttonLen:''' A float of the width of arrow button, which is affected by '''relative'''.
*'''relative:''' If set to ''true'', '''buttonLen''' will range from 0 to 1 relative to combo box's height, otherwise the '''buttonLen''' will be absolute pixels.

===captionEdit===
This property stores the caption edit when the caption is editable with [[dgsComboBoxSetEditEnabled]].
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"captionEdit",captionEdit)</syntaxhighlight>
*'''captionEdit:''' A dgs-dxedit element.

===caption===
This property stores the caption text of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"caption",caption)</syntaxhighlight>
*'''caption:''' A string of the caption text of the combo box.

===clip===
Whether the clip property is enabled (include caption text and item text). ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===color===
The color which can be translated by [[tocolor]] of the background of the combobox (behind arrow).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"color",{normalColor,hoveringColor,clickedColor})</syntaxhighlight>
*'''normalColor:''' An integer of the color of the combobox ( neither selected nor clicked by mouse ).
*'''hoveringColor:''' An integer of the color of the combobox which is selected.
*'''clickedColor:''' An integer of the color of the comboox which is clicked.

===colorcoded===
Whether the color code is enabled (include caption text and item text). ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"colorcoded",colorcoded)</syntaxhighlight>
*'''colorcoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the combo box.

===scrollBarThick===
This property determines the thickness of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"scrollBarThick",scrollBarThick)</syntaxhighlight>
*'''scrollBarThick:''' An integer of the thickness of scroll bar.

===shadow===
The shadow of the text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the combo box.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the combo box.
*'''color:''' An integer of the color of the shadow text of the combo box.
*'''outline:''' A bool of the outline state of the shadow text.

===myBox===
Combo box is composed by dgs-dxcombobox and dgs-dxcombobox-Box. This property stores the dgs-combobox-Box of dgs-dxcombobox.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"myBox",myBox)</syntaxhighlight>
*'''myBox:''' A dgs-dxcombobox-box element.

===image===
The image of combo box ( under arrow ).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"image",{normalImage,hoveringImage,clickedImage})</syntaxhighlight>
*'''normalImage:''' A texture element of the background of the combobox ( no mouse enter and no mouse click ).
*'''hoveringImage:''' A texture element of the background of the combobox which is selected.
*'''clickedImage:''' A texture element of the background of the combobox which is clicked.

===itemAlignment===
Alignment of the item text within the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemAlignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the item text within the combo box. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the item text within the combo box. Can be "top", "center" or "bottom".

===itemTextPadding===
This property determines the item text padding of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextPadding",{paddingX,paddingY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===itemColor===
This property determines the 3 states' back ground colors of item.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemColor",{colorNormal,colorHoving,colorSelected})</syntaxhighlight>
*'''colorNormal:''' An integer of the color of the item (Normal State).
*'''colorHoving:''' An integer of the color of the item (Hoving State).
*'''colorSelected:''' An integer of the color of the item (Selected State).

===itemData===
This property stores item data.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"itemData",itemData)</syntaxhighlight>
*'''columnData:''' A table stores all item data.
'''Item Structure'''
<syntaxhighlight lang="lua">
{
textColor BackGround Image BackGround Color Text
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{ ... },
}
]]
</syntaxhighlight>

===itemImage===
This property determines the 3 states' background image of item.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemImage",{imageNormal,imageHoving,imageSelected})</syntaxhighlight>
*'''imageNormal:''' A texture of the image of the row (Normal State).
*'''imageHoving:''' A texture of the image of the row (Hoving State).
*'''imageSelected:''' A texture of the image of the row (Selected State).

===itemMoveOffset===
This property stores the move offset of item that is used to render.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemMoveOffset",itemMoveOffset)</syntaxhighlight>
*'''itemMoveOffset:''' A float stores the move offset of item that is used to render.

===itemTextColor===
This property determines the color of the item text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextColor",itemTextColor)</syntaxhighlight>
*'''itemTextColor:''' An integer of the color that can be converted by [[tocolor]].

===itemTextSize===
This property determines the scale of the item text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the item.
*'''scaleY:''' A float of the 2D Y scale of the text of the item.

===listState===
This property stores the state of combo box which determines whether the combo box is opened(1) or closed(-1).
See: [[dgsComboBoxGetState]]/[[dgsComboBoxSetState]]
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"listState",listState)</syntaxhighlight>
*'''listState:''' An integer of the state of combo box.

===moveHardness===
This property determines how hard will the combo box moves when scrolling.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"moveHardness",moveHardness)</syntaxhighlight>
*'''moveHardness:''' A float determins how hard will the combo box moves when scrolling ( should be larger than 0, lower than 1 ).

===scrollbar===
This property stores the scroll bar of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"scrollbar",scrollbar)</syntaxhighlight>
*'''scrollbar:''' a dgs-dxscrollbar element.

===select===
This property stores the selected item of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"select",select)</syntaxhighlight>
*'''select:''' A integer of the index of selected item .

===textColor===
The color which can be translated by [[tocolor]] of the caption text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the combo box.

===textPadding===
This property determines the caption text padding of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textPadding",{paddingX,paddingY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===textSize===
The scale of the capiton text of the combo box. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the combo box.
*'''scaleY:''' A float of the 2D Y scale of the text of the combo box.

===textBox===
This property determines whether the '''caption''' of combo box is enabled or not.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textBox",textBox)</syntaxhighlight>
*'''textBox:''' A bool indicates whether the '''caption''' of combo box is enabled or not.

===wordbreak===
Whether the word-break of capiton text is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(capiton ,"wordbreak",wordbreak)</syntaxhighlight>
*'''wordbreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==Property of dgs-dxcombobox-Box==
===myCombo===
Combo box is composed by dgs-dxcombobox and dgs-dxcombobox-Box. This property stores the dgs-combobox of dgs-dxcombobox-Box.
<syntaxhighlight lang="lua">dgsSetProperty(myCombo,"myCombo",myCombo)</syntaxhighlight>
*'''myComboyBox:''' A dgs-dxcombobox element.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxcombobox

2022-03-16T17:03:11Z

Zhvachka: /* itemImage */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxcombobox that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===arrow===
This property determines the arrow material of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"arrow",arrow)</syntaxhighlight>
*'''arrow:''' A material element (texture/shader/screen).

===alignment===
Alignment of the caption text within the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the caption text within the combo box. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the caption text within the combo box. Can be "top", "center" or "bottom".

===autoHideAfterSelected===
This property determines whether the drop down will be hide automatically after selected.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"autoHideAfterSelected",autoHideAfterSelected)</syntaxhighlight>
*'''autoHideAfterSelected:''' A bool indicates whether the drop down will be hide automatically after selected.

===autoSort===
This property determines whether auto sort is enabled. ''See [[dgsComboBoxSetAutoSortEnabled]]/[[dgsComboBoxGetAutoSortEnabled]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"autoSort",autoSort)</syntaxhighlight>
*'''autoSort:''' A bool of auto sort state.

===bgColor===
This property determines the background color of the combo box (behind items).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor:''' An integer of the color that can be converted by [[tocolor]].

===bgImage===
This property determines the background image of the combo box (behind items).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage:''' A material element that serves as the background image of the combo box (texture/shader/screen source/renderTarget).

===buttonLen===
This property stores the width of the arrow button.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"buttonLen",{buttonLen,relative})</syntaxhighlight>
*'''buttonLen:''' A float of the width of arrow button, which is affected by '''relative'''.
*'''relative:''' If set to ''true'', '''buttonLen''' will range from 0 to 1 relative to combo box's height, otherwise the '''buttonLen''' will be absolute pixels.

===captionEdit===
This property stores the caption edit when the caption is editable with [[dgsComboBoxSetEditEnabled]].
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"captionEdit",captionEdit)</syntaxhighlight>
*'''captionEdit:''' A dgs-dxedit element.

===caption===
This property stores the caption text of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"caption",caption)</syntaxhighlight>
*'''caption:''' A string of the caption text of the combo box.

===clip===
Whether the clip property is enabled (include caption text and item text). ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===color===
The color which can be translated by [[tocolor]] of the background of the combobox (behind arrow).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"color",{normalColor,hoveringColor,clickedColor})</syntaxhighlight>
*'''normalColor:''' An integer of the color of the combobox ( neither selected nor clicked by mouse ).
*'''hoveringColor:''' An integer of the color of the combobox which is selected.
*'''clickedColor:''' An integer of the color of the comboox which is clicked.

===colorcoded===
Whether the color code is enabled (include caption text and item text). ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"colorcoded",colorcoded)</syntaxhighlight>
*'''colorcoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the combo box.

===scrollBarThick===
This property determines the thickness of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"scrollBarThick",scrollBarThick)</syntaxhighlight>
*'''scrollBarThick:''' An integer of the thickness of scroll bar.

===shadow===
The shadow of the text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the combo box.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the combo box.
*'''color:''' An integer of the color of the shadow text of the combo box.
*'''outline:''' A bool of the outline state of the shadow text.

===myBox===
Combo box is composed by dgs-dxcombobox and dgs-dxcombobox-Box. This property stores the dgs-combobox-Box of dgs-dxcombobox.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"myBox",myBox)</syntaxhighlight>
*'''myBox:''' A dgs-dxcombobox-box element.

===image===
The image of combo box ( under arrow ).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"image",{normalImage,hoveringImage,clickedImage})</syntaxhighlight>
*'''normalImage:''' A texture element of the background of the combobox ( no mouse enter and no mouse click ).
*'''hoveringImage:''' A texture element of the background of the combobox which is selected.
*'''clickedImage:''' A texture element of the background of the combobox which is clicked.

===itemAlignment===
Alignment of the item text within the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemAlignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the item text within the combo box. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the item text within the combo box. Can be "top", "center" or "bottom".

===itemTextPadding===
This property determines the item text padding of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextPadding",{paddingX,paddingY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===itemColor===
This property determines the 3 states' back ground colors of item.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemColor",{colorNormal,colorHoving,colorSelected})</syntaxhighlight>
*'''colorNormal:''' An integer of the color of the item (Normal State).
*'''colorHoving:''' An integer of the color of the item (Hoving State).
*'''colorSelected:''' An integer of the color of the item (Selected State).

===itemData===
This property stores item data.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"itemData",itemData)</syntaxhighlight>
*'''columnData:''' A table stores all item data.
'''Item Structure'''
<syntaxhighlight lang="lua">
{
textColor BackGround Image BackGround Color Text
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{ ... },
}
]]
</syntaxhighlight>

===itemImage===
This property determines the 3 states' background image of item.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemImage",{imageNormal,imageHoving,imageSelected})</syntaxhighlight>
*'''imageNormal:''' A texture of the image of the row (Normal State).
*'''imageHoving:''' A texture of the image of the row (Hoving State).
*'''imageSelected:''' A texture of the image of the row (Selected State).

===itemMoveOffset===
This property stores the move offset of item that is used to render.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemMoveOffset",itemMoveOffset)</syntaxhighlight>
*'''itemMoveOffset:''' A float stores the move offset of item that is used to render.

===itemTextColor===
This property determines the color of the item text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextColor",itemTextColor)</syntaxhighlight>
*'''itemTextColor:''' An integer of the color that can be converted by [[tocolor]].

===itemTextSize===
This property determines the scale of the item text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the item.
*'''scaleY:''' A float of the 2D Y scale of the text of the item.

===listState===
This property stores the state of combo box which determines whether the combo box is opened(1) or closed(-1).
See: [[dgsComboBoxGetState]]/[[dgsComboBoxSetState]]
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"listState",listState)</syntaxhighlight>
*'''listState:''' An integer of the state of combo box.

===moveHardness===
This property determines how hard will the combo box moves when scrolling.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"moveHardness",moveHardness)</syntaxhighlight>
*'''moveHardness:''' A float determins how hard will the combo box moves when scrolling ( should be larger than 0, lower than 1 ).

===scrollbar===
This property stores the scroll bar of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"scrollbar",scrollbar)</syntaxhighlight>
*'''scrollbar:''' a dgs-dxscrollbar element.

===select===
This property stores the selected item of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"select",select)</syntaxhighlight>
*'''select:''' A integer of the index of selected item .

===textColor===
The color which can be translated by [[tocolor]] of the caption text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the combo box.

===textPadding===
This property determines the caption text padding of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textPadding",{paddingX,alignY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===textSize===
The scale of the capiton text of the combo box. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the combo box.
*'''scaleY:''' A float of the 2D Y scale of the text of the combo box.

===textBox===
This property determines whether the '''caption''' of combo box is enabled or not.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textBox",textBox)</syntaxhighlight>
*'''textBox:''' A bool indicates whether the '''caption''' of combo box is enabled or not.

===wordbreak===
Whether the word-break of capiton text is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(capiton ,"wordbreak",wordbreak)</syntaxhighlight>
*'''wordbreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==Property of dgs-dxcombobox-Box==
===myCombo===
Combo box is composed by dgs-dxcombobox and dgs-dxcombobox-Box. This property stores the dgs-combobox of dgs-dxcombobox-Box.
<syntaxhighlight lang="lua">dgsSetProperty(myCombo,"myCombo",myCombo)</syntaxhighlight>
*'''myComboyBox:''' A dgs-dxcombobox element.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxcheckbox

2022-03-16T16:59:21Z

Zhvachka: /* textPadding */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxcheckbox that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alignment===
Alignment of the text within the checkbox.

The functions as follows are basic on this property.

[[dgsCheckBoxSetHorizontalAlign]]/[[dgsCheckBoxGetHorizontalAlign]]

[[dgsCheckBoxSetVerticalAlign]]/[[dgsCheckBoxGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(checkbx,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the checkbox. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the checkbox. Can be "top", "center" or "bottom".

===buttonSize===
This property determines the button size of the check box.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"buttonSize",{size,relative})</syntaxhighlight>
*'''size:''' A number of the size of the button on screen.
*'''relative:''' A bool indicates whether the size is relative or absolute.

<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"buttonSize",{width,height,relative})</syntaxhighlight>
*'''width:''' A number of the width of the button on screen.
*'''height:''' A number of the height of the button on screen.
*'''relative:''' A bool indicates whether the size is relative or absolute.

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===color_i===
This property determines the color of the icon under 3 conditions when the check box is indeterminate.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"color_i",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (indeterminate)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (indeterminate)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (indeterminate)

===color_f===
This property determines the color of the icon under 3 conditions when the check box is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"color_f",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (unchecked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (unchecked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (unchecked)

===color_t===
This property determines the color of the icon under 3 conditions when the check box is checked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"color_t",{ColorNormal,ColorHover,ColorClick})</syntaxhighlight>
*'''ColorNormal:''' An integer of the color of the icon under normal state. (checked)
*'''ColorHover:''' An integer of the color of the icon under hovering state. (checked)
*'''ColorClick:''' An integer of the color of the icon under clicked state. (checked)

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the checkbox.

===image_f===
This property determines the icon under 3 conditions when the check box is unchecked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"image_f",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (unchecked)
*'''ImageHover:''' An image element of the icon under hovering state. (unchecked)
*'''ImageClick:''' An image element of the icon under clicked state. (unchecked)

===image_i===
This property determines the icon under 3 conditions when the check box is indeterminate.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"image_i",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (indeterminate)
*'''ImageHover:''' An image element of the icon under hovering state. (indeterminate)
*'''ImageClick:''' An image element of the icon under clicked state. (indeterminate)

===image_t===
This property determines the icon under 3 conditions when the check box is checked.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"image_t",{ImageNormal,ImageHover,ImageClick})</syntaxhighlight>
*'''ImageNormal:''' An image element of the icon under normal state. (checked)
*'''ImageHover:''' An image element of the icon under hovering state. (checked)
*'''ImageClick:''' An image element of the icon under clicked state. (checked)

===shadow===
The shadow text of the checkbox.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the checkbox.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the checkbox.
*'''color:''' An integer of the color of the shadow text of the checkbox.
*'''outline:''' A bool of the outline state of the shadow text.

===state===
This property stores the state of the check box.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"state",state)</syntaxhighlight>
*'''state:''' A bool/nil of the state. Values can be as follows:
**'''true:''' Checked
**'''false:''' Unchecked
**'''nil:''' indeterminate

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"text",text)</syntaxhighlight>
*'''text:''' A string of the text of the checkbox.

===textColor===
The color which can be translated by [[tocolor]] of the text of the checkbox.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the checkbox.

===textPadding===
This property determines the padding between the text and icon.
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textPadding",textPadding)</syntaxhighlight>
*'''textPadding''' A float of the distance from the icon to the text of the check box.

===textSize===
The scale of the text of the checkbox. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the checkbox.
*'''scaleY:''' A float of the 2D Y scale of the text of the checkbox.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(checkbox,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxcombobox

2022-03-16T16:43:23Z

Zhvachka: fix a typo

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxcombobox that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===arrow===
This property determines the arrow material of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"arrow",arrow)</syntaxhighlight>
*'''arrow:''' A material element (texture/shader/screen).

===alignment===
Alignment of the caption text within the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the caption text within the combo box. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the caption text within the combo box. Can be "top", "center" or "bottom".

===autoHideAfterSelected===
This property determines whether the drop down will be hide automatically after selected.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"autoHideAfterSelected",autoHideAfterSelected)</syntaxhighlight>
*'''autoHideAfterSelected:''' A bool indicates whether the drop down will be hide automatically after selected.

===autoSort===
This property determines whether auto sort is enabled. ''See [[dgsComboBoxSetAutoSortEnabled]]/[[dgsComboBoxGetAutoSortEnabled]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"autoSort",autoSort)</syntaxhighlight>
*'''autoSort:''' A bool of auto sort state.

===bgColor===
This property determines the background color of the combo box (behind items).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor:''' An integer of the color that can be converted by [[tocolor]].

===bgImage===
This property determines the background image of the combo box (behind items).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage:''' A material element that serves as the background image of the combo box (texture/shader/screen source/renderTarget).

===buttonLen===
This property stores the width of the arrow button.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"buttonLen",{buttonLen,relative})</syntaxhighlight>
*'''buttonLen:''' A float of the width of arrow button, which is affected by '''relative'''.
*'''relative:''' If set to ''true'', '''buttonLen''' will range from 0 to 1 relative to combo box's height, otherwise the '''buttonLen''' will be absolute pixels.

===captionEdit===
This property stores the caption edit when the caption is editable with [[dgsComboBoxSetEditEnabled]].
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"captionEdit",captionEdit)</syntaxhighlight>
*'''captionEdit:''' A dgs-dxedit element.

===caption===
This property stores the caption text of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"caption",caption)</syntaxhighlight>
*'''caption:''' A string of the caption text of the combo box.

===clip===
Whether the clip property is enabled (include caption text and item text). ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===color===
The color which can be translated by [[tocolor]] of the background of the combobox (behind arrow).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"color",{normalColor,hoveringColor,clickedColor})</syntaxhighlight>
*'''normalColor:''' An integer of the color of the combobox ( neither selected nor clicked by mouse ).
*'''hoveringColor:''' An integer of the color of the combobox which is selected.
*'''clickedColor:''' An integer of the color of the comboox which is clicked.

===colorcoded===
Whether the color code is enabled (include caption text and item text). ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"colorcoded",colorcoded)</syntaxhighlight>
*'''colorcoded:''' Set to true to enable embedded #FFFFFF color codes.

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"font",font)</syntaxhighlight>
*'''font:''' A string or a [[Element/DX_font|dx font element]] of the text font of the combo box.

===scrollBarThick===
This property determines the thickness of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"scrollBarThick",scrollBarThick)</syntaxhighlight>
*'''scrollBarThick:''' An integer of the thickness of scroll bar.

===shadow===
The shadow of the text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the combo box.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the combo box.
*'''color:''' An integer of the color of the shadow text of the combo box.
*'''outline:''' A bool of the outline state of the shadow text.

===myBox===
Combo box is composed by dgs-dxcombobox and dgs-dxcombobox-Box. This property stores the dgs-combobox-Box of dgs-dxcombobox.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"myBox",myBox)</syntaxhighlight>
*'''myBox:''' A dgs-dxcombobox-box element.

===image===
The image of combo box ( under arrow ).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"image",{normalImage,hoveringImage,clickedImage})</syntaxhighlight>
*'''normalImage:''' A texture element of the background of the combobox ( no mouse enter and no mouse click ).
*'''hoveringImage:''' A texture element of the background of the combobox which is selected.
*'''clickedImage:''' A texture element of the background of the combobox which is clicked.

===itemAlignment===
Alignment of the item text within the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemAlignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the item text within the combo box. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the item text within the combo box. Can be "top", "center" or "bottom".

===itemTextPadding===
This property determines the item text padding of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextPadding",{paddingX,paddingY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===itemColor===
This property determines the 3 states' back ground colors of item.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemColor",{colorNormal,colorHoving,colorSelected})</syntaxhighlight>
*'''colorNormal:''' An integer of the color of the item (Normal State).
*'''colorHoving:''' An integer of the color of the item (Hoving State).
*'''colorSelected:''' An integer of the color of the item (Selected State).

===itemData===
This property stores item data.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"itemData",itemData)</syntaxhighlight>
*'''columnData:''' A table stores all item data.
'''Item Structure'''
<syntaxhighlight lang="lua">
{
textColor BackGround Image BackGround Color Text
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{ ... },
}
]]
</syntaxhighlight>

===itemImage===
This property determines the 3 states' background image of item.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemImage",{imageDefault,cimageHoving,imageSelected})</syntaxhighlight>
*'''imageNormal:''' A texture of the image of the row (Normal State).
*'''cimageHoving:''' A texture of the image of the row (Hoving State).
*'''imageSelected:''' A texture of the image of the row (Selected State).

===itemMoveOffset===
This property stores the move offset of item that is used to render.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemMoveOffset",itemMoveOffset)</syntaxhighlight>
*'''itemMoveOffset:''' A float stores the move offset of item that is used to render.

===itemTextColor===
This property determines the color of the item text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextColor",itemTextColor)</syntaxhighlight>
*'''itemTextColor:''' An integer of the color that can be converted by [[tocolor]].

===itemTextSize===
This property determines the scale of the item text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the item.
*'''scaleY:''' A float of the 2D Y scale of the text of the item.

===listState===
This property stores the state of combo box which determines whether the combo box is opened(1) or closed(-1).
See: [[dgsComboBoxGetState]]/[[dgsComboBoxSetState]]
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"listState",listState)</syntaxhighlight>
*'''listState:''' An integer of the state of combo box.

===moveHardness===
This property determines how hard will the combo box moves when scrolling.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"moveHardness",moveHardness)</syntaxhighlight>
*'''moveHardness:''' A float determins how hard will the combo box moves when scrolling ( should be larger than 0, lower than 1 ).

===scrollbar===
This property stores the scroll bar of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"scrollbar",scrollbar)</syntaxhighlight>
*'''scrollbar:''' a dgs-dxscrollbar element.

===select===
This property stores the selected item of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"select",select)</syntaxhighlight>
*'''select:''' A integer of the index of selected item .

===textColor===
The color which can be translated by [[tocolor]] of the caption text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the combo box.

===textPadding===
This property determines the caption text padding of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textPadding",{paddingX,alignY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===textSize===
The scale of the capiton text of the combo box. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the combo box.
*'''scaleY:''' A float of the 2D Y scale of the text of the combo box.

===textBox===
This property determines whether the '''caption''' of combo box is enabled or not.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textBox",textBox)</syntaxhighlight>
*'''textBox:''' A bool indicates whether the '''caption''' of combo box is enabled or not.

===wordbreak===
Whether the word-break of capiton text is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(capiton ,"wordbreak",wordbreak)</syntaxhighlight>
*'''wordbreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==Property of dgs-dxcombobox-Box==
===myCombo===
Combo box is composed by dgs-dxcombobox and dgs-dxcombobox-Box. This property stores the dgs-combobox of dgs-dxcombobox-Box.
<syntaxhighlight lang="lua">dgsSetProperty(myCombo,"myCombo",myCombo)</syntaxhighlight>
*'''myComboyBox:''' A dgs-dxcombobox element.

==See Also==
{{DGSPROPERTIES}}