DgsGetText: Difference between revisions

Revision as of 15:39, 16 January 2018

This function is used to get the text of DGS elements like edit boxes, labels, buttons etc.

Syntax

string dgsGetText ( element guiElement )

Required Arguments

guiElement: element you wish to get text of.

Returns

Returns a string containing the requested element's text, or false if the dgs element passed to the function is invalid.

Example

This example gets the text of a pre-made dgs element and outputs it to chat box.

DGS = exports.dgs
-- We create a dummy dgs label to get text of
local dummyGUIElement = DGS:dgsCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
-- Output the text of the label to chat box
outputChatBox ( "Text in the DGS label: " .. DGS:dgsGetText ( dummyGUIElement ) )

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

dgsCreateBrowser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

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

dgsCreateCanvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

@@ Line 7: / Line 7: @@
 <!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
 <syntaxhighlight lang="lua">
-string dgsDxGUIGetText ( element guiElement )
+string dgsGetText ( element guiElement )
 </syntaxhighlight>
@@ Line 25: / Line 25: @@
 DGS = exports.dgs
 -- We create a dummy dgs label to get text of
-local dummyGUIElement = DGS:dgsDxCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
+local dummyGUIElement = DGS:dgsCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
 -- Output the text of the label to chat box
-outputChatBox ( "Text in the DGS label: " .. DGS:dgsDxGUIGetText ( dummyGUIElement ) )
+outputChatBox ( "Text in the DGS label: " .. DGS:dgsGetText ( dummyGUIElement ) )
 </syntaxhighlight>