DgsMemoGetPartOfText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 3: Line 3:
This function returns a part of text from the memo by index and line.
This function returns a part of text from the memo by index and line.


'''Notice:''' dgsDxMemoGetPartOfText(memo) is equivalent to [[dgsDxGUIGetText]](memo)
'''Notice:''' dgsMemoGetPartOfText(memo) is equivalent to [[dgsGetText]](memo)


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string dgsDxMemoGetPartOfText ( element theElement [, int fromindex = 0, int fromline = 1, int toindex, int toline, bool deleteText = false ] )
string dgsMemoGetPartOfText ( element theElement [, int fromindex = 0, int fromline = 1, int toindex, int toline, bool deleteText = false ] )
</syntaxhighlight>  
</syntaxhighlight>  


Line 26: Line 26:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
DGS = exports.dgs
memo = DGS:dgsDxCreateMemo(500,200,200,300,"This is a dgs-dxmemo",false)
memo = DGS:dgsCreateMemo(500,200,200,300,"This is a dgs-dxmemo",false)
text = DGS:dgsDxMemoGetPartOfText(memo,1,1,1,3)
text = DGS:dgsMemoGetPartOfText(memo,1,1,1,3)
outputChatBox(text)
outputChatBox(text)
</syntaxhighlight>
</syntaxhighlight>

Revision as of 10:54, 20 January 2018

This function returns a part of text from the memo by index and line.

Notice: dgsMemoGetPartOfText(memo) is equivalent to dgsGetText(memo)

Syntax

string dgsMemoGetPartOfText ( element theElement [, int fromindex = 0, int fromline = 1, int toindex, int toline, bool deleteText = false ] )

Required Arguments

  • theElement: The memo to be changed.

Optional Arguments

  • fromindex: An integer indicated where the text of the memo is selected from ( the text index of current 'fromline'. start from 0 ).
  • fromline: An integer indicated which line of the text of the memo is selected from ( start from 1 ).
  • toindex: An integer indicated where the text of the memo is selected to ( the text index of current 'toline'. start from 0 ).
  • toline: An integer indicated which line of the text of the memo is selected to ( start from 1 ).
  • deleteText: A bool indicated whether the selected text will be deleted after calling this function.

Returns

Returns a string of the selected text if successful, false otherwise.

Example

DGS = exports.dgs
memo = DGS:dgsCreateMemo(500,200,200,300,"This is a dgs-dxmemo",false)
text = DGS:dgsMemoGetPartOfText(memo,1,1,1,3)
outputChatBox(text)

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