Dgs-dxedit

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

bgColor

This property determines the background color of the edit.

dgsSetProperty(edit,"bgColor",bgColor)

• bgColor : An integer of the color that can be converted by tocolor.

bgImage

This property determines the background image of the edit.

dgsSetProperty(edit,"bgImage",bgImage)

• bgImage : A material element that serves as the background image of the edit (texture/shader/screen source/renderTarget).

caretPos

The position where the caret stays.

dgsSetProperty(edit,"caretPos",index)

• index : An integer of the index of the text that the caret stays.

text

This is equivalent to dgsSetText/dgsGetText.

dgsSetProperty(edit,"text",text)

• text : A table of the text of the edit.( Because of multi lines, I use table instead of string )

maxLength

This is equivalent to dgsEditGetMaxLength/dgsEditSetMaxLength

dgsSetProperty(edit,"maxLength",maxLength)

• maxLength : An integer indicating the maximum number of characters that can be typed into the edit box.

textColor

The color which can be translated by tocolor of the text of the edit.

dgsSetProperty(edit,"textColor",textColor)

• textColor : An integer of the color of the text of the edit.

textSize

The scale of the text of the edit. Learn More dxDrawText

dgsSetProperty(edit,"textSize",{scaleX,scaleY})

• 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.

masked

This is equivalent to dgsEditSetMasked/dgsEditGetMasked

dgsSetProperty(edit,"masked",masked)

• 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 "*".

dgsSetProperty(edit,"maskText",maskText)

• maskText : A string that the masked text will be.

selectFrom

The position from which the text is selected.

dgsSetProperty(edit,"selectFrom",{index,line})

• index : An integer of the index of the text that selected from.

font

This is equivalent to dgsSetFont/dgsGetFont. Learn More dxDrawText

dgsSetProperty(edit,"font",font)

• font : A dx font element of the text font of the edit.

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 )

dgsSetProperty(edit,"showPos",posX)

• posX : An integer indicates how many pixels of the text are moved to left.

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_

dgsSetProperty(edit,"caretStyle",caretStyle)

• cursorStyle : An integer of the caret style of the edit.

caretThick

This property allows us to change the thickness of caret of the edit.

dgsSetProperty(edit,"caretThick",caretThick)

• caretThick : An integer of the thickness of the caret of the edit.

caretOffset

The offset of the caret of the edit.

dgsSetProperty(edit,"caretOffset",{offsetX,offsetY})

• offsetX : A float of the 2D X position offset of the caret of the edit.
• offsetY : A float of the 2D Y position offset of the caret of the edit.

caretColor

This property determines the color of the caret

dgsSetProperty(edit,"caretColor",caretColor)

• caretColor : An integer of the color that can be converted by tocolor.

readOnly

This is equivalent to dgsEditSetReadOnly/dgsEditGetReadOnly.

dgsSetProperty(edit,"readOnly",readOnly)

• readOnly : A bool indicates whether the edit is only readable.

readOnlyCaretShow

Whether the caret of edit will show/hide under read-only mode.

dgsSetProperty(edit,"readOnlyCaretShow",readOnlyCaretShow)

• readOnlyCaretShow : A bool indicates whether the caret is shown or hidden when the edit is read-only.

selectColor

The color which can be translated by tocolor of the rectangle of test selection of the edit.

dgsSetProperty(edit,"selectColor",selectColor)

• selectColor : An integer of the color of the rectangle of test selection of the edit.

padding

This property determines the padding of the text.

dgsSetProperty(edit,"padding",{paddingX,paddingY})

• paddingX : An integer of 2D x padding value.
• paddingY : An integer of 2D y padding value.

edit

This property stores a gui-edit which is used to input characters.

dgsSetProperty(edit,"edit",gedit)

• gedit : A gui-edit.

renderTarget

This property stores a render target of the edit.

dgsSetProperty(edit,"renderTarget",renderTarget)

• renderTarget : A render target that is used to render the text.

enableTabSwitch

This property determines whether we can use the key "tab" to switch to another edit.

dgsSetProperty(edit,"enableTabSwitch",enableTabSwitch)

• enableTabSwitch : A bool indicates whether we can use the key tab to switch to another edit.

clearSelection

This property determines whether the text selection will be cleared when the edit blurs.

dgsSetProperty(edit,"clearSelection",clearSelection)

• clearSelection : A bool indicates whether the text selection will be cleared when the edit blurs.

caretHeight

This property determines what's the height of the caret.

dgsSetProperty(edit,"caretHeight",caretHeight)

• caretHeight : A bool indicates what's the height of the caret.

alignment

Alignment of the text within the edit.

The functions as follows are basic on this property.

dgsEditSetHorizontalAlign/dgsEditGetHorizontalAlign

dgsEditSetVerticalAlign/dgsEditGetVerticalAlign

dgsSetProperty(edit,"alignment",{alignX,alignY})

• 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 )

dgsSetProperty(edit,"allowCopy",allowCopy)

• allowCopy : A bool indicates whjether the text can be copyed ( ctrl+c ) or cut ( ctrl+x )

typingSound

Typing sound, nil for disabled. This is equivalent to dgsEditSetTypingSound/dgsEditGetTypingSound

dgsSetProperty(edit,"typingSound",typingSound)

• typingSound: A string of the path/url of typing sound.

See Also

General Properties

• DGS General Basic Properties

Unique Properties For DGS Core Elements

• dgs-dx3dinterface
• dgs-dx3dimage
• dgs-dx3dtext
• dgs-dx3dline
• dgs-dxbutton
• dgs-dxcheckbox
• dgs-dxcombobox
• dgs-dxdetectarea
• dgs-dxedit
• dgs-dxgridlist
• dgs-dximage
• dgs-dxlabel
• dgs-dxline
• dgs-dxmemo
• dgs-dxprogressbar
• dgs-dxradiobutton
• dgs-dxscrollbar
• dgs-dxscrollpane
• dgs-dxselector
• dgs-dxswitchbutton
• dgs-dxtabpanel
• dgs-dxtab
• dgs-dxwindow