DgsEditGetAlignment: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
[[Image:DGS Edit Alignment.png|550px|thumb|right|DGS Edit Alignment]]
This function gets both vertical and horizontal alignment of a dgs edit.
This function gets both vertical and horizontal alignment of a dgs edit.
Horizontal Alignment:
 
'''Horizontal Alignment:'''
*"left"
*"left"
*"center"
*"center"
*"right"
*"right"
Vertical Alignment:
'''Vertical Alignment:'''
*"top"
*"top"
*"center"
*"center"
Line 13: Line 15:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsEditSetVerticalAlign ( element theEdit [, string horizontalAlignment, string verticalAlignment ] )
string,string dgsEditSetVerticalAlign ( element theEdit )
</syntaxhighlight>
</syntaxhighlight>
[[Image:DGS Edit Alignment.png|800px|thumb|right|DGS Edit Alignment]]


===Required Arguments===  
===Required Arguments===  
*'''theEdit:''' The dgs edit to set the alignment on.
*'''theEdit:''' The dgs edit to set the alignment on.
===Optional Arguments===
*'''horizontalAlignment :''' The alignment type. Valid type strings are:
**"left"
**"center"
**"right"
*'''verticalAlignment :''' The alignment type. Valid type strings are:
**"top"
**"center"
**"bottom"


===Returns===
===Returns===
Returns ''true'' if successful, ''false'' otherwise.
Returns two string value if successful, ''false'' otherwise.


==Example==  
==Example==  
Line 37: Line 28:
DGS = exports.dgs
DGS = exports.dgs
local edit = DGS:dgsCreateEdit ( 300, 200, 500, 50, "Text", false )
local edit = DGS:dgsCreateEdit ( 300, 200, 500, 50, "Text", false )
DGS:dgsEditSetAlignment( edit, "center" , "center" )
horizontal,vertical = DGS:dgsEditGetAlignment( edit )
outputChatBox(horizontal.." "..vertical)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{DGSFUNCTIONS}}
{{DGSFUNCTIONS}}

Revision as of 05:59, 4 May 2019

DGS Edit Alignment

This function gets both vertical and horizontal alignment of a dgs edit.

Horizontal Alignment:

  • "left"
  • "center"
  • "right"

Vertical Alignment:

  • "top"
  • "center"
  • "bottom"

Syntax

string,string dgsEditSetVerticalAlign ( element theEdit )

Required Arguments

  • theEdit: The dgs edit to set the alignment on.

Returns

Returns two string value if successful, false otherwise.

Example

DGS = exports.dgs
local edit = DGS:dgsCreateEdit ( 300, 200, 500, 50, "Text", false )
horizontal,vertical = DGS:dgsEditGetAlignment( edit )
outputChatBox(horizontal.." "..vertical)

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips