Reference for .Net version of SpaceVIL  0.3.5.8
SpaceVIL (Space of Visual Items Layout) is a cross-platform and multilingual framework for creating GUI client applications for .NET Standard, .NET Core and JVM. SpaceVIL is based on OpenGL graphic technology and GLFW. Using this framework in conjunction with .Net Core or with a JVM, you can work and create graphical client applications on Linux, Mac OS X and Windows.
SpaceVIL.TextArea Class Reference

TextArea is a basic implementation of a user interface editable text area. Contains text area, scroll bars, menu button, navigation context menu. Supports all events except drag and drop. More...

Inherits SpaceVIL.Prototype.

Public Member Functions

void DisableMenu (bool value)
 Setting the navigation context menu to disable or enable. Default: False. More...
 
bool IsEditable ()
 Returns True if TextArea is editable otherwise returns False. More...
 
void SetEditable (bool value)
 Setting TextArea text field be editable or be non-editable. More...
 
VisibilityPolicy GetVScrollBarPolicy ()
 Getting vertical scroll bar visibility policy. More...
 
void SetVScrollBarPolicy (VisibilityPolicy policy)
 Setting vertical scroll bar visibility policy. Default: SpaceVIL.Core.VisibilityPolicy.AsNeeded. More...
 
VisibilityPolicy GetHScrollBarPolicy ()
 Getting horizontal scroll bar visibility policy. More...
 
void SetHScrollBarPolicy (VisibilityPolicy policy)
 Setting horizontal scroll bar visibility policy. Default: SpaceVIL.Core.VisibilityPolicy.AsNeeded. More...
 
 TextArea ()
 Default TextArea constructor. More...
 
 TextArea (String text)
 Constructs TextArea with the specified text. More...
 
override void SetWidth (int width)
 Setting item width. If the value is greater/less than the maximum/minimum value of the width, then the width becomes equal to the maximum/minimum value. More...
 
override void SetHeight (int height)
 Setting item height. If the value is greater/less than the maximum/minimum value of the height, then the height becomes equal to the maximum/minimum value. More...
 
override void InitElements ()
 Initializing all elements in the TextArea. Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually. More...
 
void SetText (String text)
 Setting the text. More...
 
String GetText ()
 Getting the current text of the TextArea. More...
 
override void SetStyle (Style style)
 Setting style of the TextArea. Inner styles: "vscrollbar", "hscrollbar", "textedit", "menu". More...
 
void SetLineSpacer (int lineSpacer)
 Setting indent between lines in TextArea. More...
 
int GetLineSpacer ()
 Getting current indent between lines in TextArea. More...
 
void SetTextMargin (Indents margin)
 Setting indents for the text to offset text relative to this TextArea. More...
 
void SetTextMargin (int left=0, int top=0, int right=0, int bottom=0)
 Setting indents for the text to offset text relative to TextArea. More...
 
Indents GetTextMargin ()
 Getting indents of the text. More...
 
void SetFont (Font font)
 Setting font of the text. More...
 
void SetFontSize (int size)
 Setting font size of the text. More...
 
void SetFontStyle (FontStyle style)
 Setting font style of the text. More...
 
void SetFontFamily (FontFamily fontFamily)
 Setting new font family of the text. More...
 
Font GetFont ()
 Getting the current font of the text. More...
 
int GetTextWidth ()
 Getting the text width. More...
 
int GetTextHeight ()
 Getting the text height. More...
 
void SetForeground (Color color)
 Setting text color of a TextArea. More...
 
void SetForeground (int r, int g, int b)
 Setting text color of a TextArea in byte RGB format. More...
 
void SetForeground (int r, int g, int b, int a)
 Setting text color of a TextArea in byte RGBA format. More...
 
void SetForeground (float r, float g, float b)
 Setting text color of a TextArea in float RGB format. More...
 
void SetForeground (float r, float g, float b, float a)
 Setting text color of a TextArea in float RGBA format. More...
 
Color GetForeground ()
 Getting current text color. More...
 
override void SetFocus ()
 Setting focus on TextArea if it is focusable. More...
 
override void Clear ()
 Deletes all text in the TextArea. More...
 
void AppendText (String text)
 Adding the specified text to the end of the existing text. More...
 
void PasteText (String text)
 Paste the specified text at the current position of the text cursor (or replace the specified text at the current starting position of the selected text). More...
 
string CutText ()
 Cuts and returns the current selected text. More...
 
string GetSelectedText ()
 Getting the current selected text. More...
 
void RewindText ()
 Moves text cursor to the text beginning. More...
 
bool IsWrapText ()
 Returns True if TextArea wraps the contained text to the width of the TextArea otherwise returns False. More...
 
void SetWrapText (bool value)
 Setting TextArea mode that wraps (or not wraps) input text to the width of the TextArea. More...
 
void SetScrollStepFactor (float value)
 Setting scroll step factor. The scroll factor determines how many lines are scrolled in a single scroll request (using a button or mouse wheel). Default: 1.0 More...
 
- Public Member Functions inherited from SpaceVIL.Prototype
 Prototype ()
 Default constructor of Prototype class. More...
 
virtual void Release ()
 Method to describe disposing item's resources if the item was removed. Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually. More...
 
void SetHandler (CoreWindow handler)
 Setting the window to which the item will belong. More...
 
CoreWindow GetHandler ()
 Getting the window to which the item belongs. More...
 
String GetToolTip ()
 Getting tooltip text of the item. Tooltip is hint about an item that appears when you hold the mouse cursor over an item long enough. More...
 
void SetToolTip (String text)
 Setting tooltip text of the item. Tooltip is hint about an item that appears when you hold the mouse cursor over an item long enough. More...
 
Prototype GetParent ()
 Getting the parent of the item. More...
 
void SetParent (Prototype parent)
 Setting the parent of the item. More...
 
Spacing GetSpacing ()
 Getting indents between children of a container type item. More...
 
void SetSpacing (Spacing spacing)
 Setting indents between children of a container type item. More...
 
void SetSpacing (int horizontal=0, int vertical=0)
 Setting indents between children of a container type item. More...
 
Indents GetPadding ()
 Getting indents of an item for offset its children. More...
 
void SetPadding (Indents padding)
 Setting indents of an item to offset its children. More...
 
void SetPadding (int left=0, int top=0, int right=0, int bottom=0)
 Setting indents of an item to offset its children. More...
 
Indents GetMargin ()
 Getting the indents of an item to offset itself relative to its container. More...
 
void SetMargin (Indents margin)
 Setting the indents of an item to offset itself relative to its container. More...
 
void SetMargin (int left=0, int top=0, int right=0, int bottom=0)
 Setting the indents of an item to offset itself relative to its container. More...
 
void SetBorder (Border border)
 Setting border of an item's shape. Border consist of corner radiuses, thickness and color. More...
 
void SetBorderFill (Color fill)
 Setting the border color of an item's shape. More...
 
Color GetBorderFill ()
 Getting the border color oa an item's shape. More...
 
void SetBorderFill (int r, int g, int b, int a=255)
 Setting the border color of an item's shape in byte RGBA format. More...
 
void SetBorderFill (float r, float g, float b, float a=1.0f)
 Setting the border color of an item's shape in float RGBA format. More...
 
void SetBorderRadius (CornerRadius radius)
 Setting radius of the border's corners. More...
 
void SetBorderRadius (int radius)
 Setting border radius with the same values for each corner of the rectangle object. More...
 
CornerRadius GetBorderRadius ()
 Getting border radiuses. More...
 
void SetBorderThickness (int thickness)
 Setting border thickness of an item's shape. More...
 
int GetBorderThickness ()
 Getting border thickness of an item's shape. More...
 
List< float[]> GetTriangles ()
 Getting triangles of item's shape. More...
 
virtual void SetTriangles (List< float[]> triangles)
 Setting triangles as item's shape. More...
 
virtual void MakeShape ()
 Making default item's shape. Use in conjunction with GetTriangles() and SetTriangles() methods. Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually. More...
 
virtual void SetBackground (Color color)
 Setting background color of an item's shape. More...
 
virtual void SetBackground (int r, int g, int b)
 Setting background color of an item's shape in byte RGB format. More...
 
virtual void SetBackground (int r, int g, int b, int a)
 Setting background color of an item in byte RGBA format. More...
 
virtual void SetBackground (float r, float g, float b)
 Setting background color of an item in float RGB format. More...
 
virtual void SetBackground (float r, float g, float b, float a)
 Setting background color of an item in float RGBA format. More...
 
virtual Color GetBackground ()
 Getting background color of an item. More...
 
void SetItemName (string name)
 Setting the name of the item. More...
 
string GetItemName ()
 Getting the name of the item. More...
 
void SetMinWidth (int width)
 Setting the minimum width limit. Actual width cannot be less than this limit. More...
 
int GetMinWidth ()
 Getting the minimum width limit. More...
 
virtual int GetWidth ()
 Getting item width. More...
 
void SetMaxWidth (int width)
 Setting the maximum width limit. Actual width cannot be greater than this limit. More...
 
int GetMaxWidth ()
 Getting the maximum width limit. More...
 
void SetMinHeight (int height)
 Setting the minimum height limit. Actual height cannot be less than this limit. More...
 
int GetMinHeight ()
 Getting the minimum height limit. More...
 
virtual int GetHeight ()
 Getting item height. More...
 
void SetMaxHeight (int height)
 Setting the maximum height limit. Actual height cannot be greater than this limit. More...
 
int GetMaxHeight ()
 Getting the maximum height limit. More...
 
virtual void SetSize (int width, int height)
 Setting item size (width and height). More...
 
Core.Size GetSize ()
 Getting current item size. More...
 
void SetMinSize (int width, int height)
 Setting minimum item size limit (width and height limits). More...
 
Core.Size GetMinSize ()
 Getting current item minimum size limit. More...
 
void SetMaxSize (int width, int height)
 Setting maximum item size limit (width and height limits). More...
 
Core.Size GetMaxSize ()
 Getting current item maximum size limit. More...
 
void SetAlignment (ItemAlignment alignment)
 Setting an alignment of an item's shape relative to its container. Combines with alignment by vertically (Top, VCenter, Bottom) and horizontally (Left, HCenter, Right). More...
 
void SetAlignment (params ItemAlignment[] alignment)
 Setting an alignment of an item's shape relative to its container. Combines with alignment by vertically (Top, VCenter, Bottom) and horizontally (Left, HCenter, Right). More...
 
ItemAlignment GetAlignment ()
 Getting an alignment of an item's shape relative to its container. More...
 
void SetSizePolicy (SizePolicy width, SizePolicy height)
 Setting the size policy of an item's shape. Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...
 
void SetWidthPolicy (SizePolicy policy)
 Setting width policy of an item's shape. Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...
 
SizePolicy GetWidthPolicy ()
 Getting width policy of an item's shape.Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...
 
void SetHeightPolicy (SizePolicy policy)
 Setting height policy of an item's shape. Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...
 
SizePolicy GetHeightPolicy ()
 Getting height policy of an item's shape.Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...
 
virtual void SetPosition (int x, int y)
 Setting item position. More...
 
virtual void SetX (int x)
 Setting X coordinate of the left-top corner of a shape. More...
 
virtual int GetX ()
 Getting X coordinate of the left-top corner of a shape. More...
 
virtual void SetY (int y)
 Setting Y coordinate of the left-top corner of a shape. More...
 
virtual int GetY ()
 Getting Y coordinate of the left-top corner of a shape. More...
 
virtual void SetConfines ()
 Setting the confines of the item relative to its parent's size and position. Example: items can be partially (or completely) outside the container (example: ListBox), in which case the part that is outside the container should not be visible and should not interact with the user. More...
 
virtual void SetConfines (int x0, int x1, int y0, int y1)
 Setting the confines of the item relative to specified bounds. Example: items can be partially (or completely) outside the container (example: ListBox), in which case the part that is outside the container should not be visible and should not interact with the user. More...
 
virtual Style GetCoreStyle ()
 Getting the core (only appearance properties without inner styles) style of an item. More...
 
bool IsShadowDrop ()
 Getting the shadow visibility status of an item. More...
 
void SetShadowDrop (bool value)
 Setting the shadow visibility status of an item. More...
 
void SetShadowRadius (int radius)
 Setting the specified blur radius of the shadow. Default: 0. More...
 
int GetShadowRadius ()
 Getting the shadow blur raduis. More...
 
Color GetShadowColor ()
 Getting shadow color. More...
 
void SetShadowColor (Color color)
 Setting shadow color. More...
 
Position GetShadowPos ()
 Getting the offset of the shadow relative to the position of the item. More...
 
int[] GetShadowExtension ()
 Getting the values of shadow extensions in pixels. More...
 
void SetShadowExtension (int wExtension, int hExtension)
 Setting the values of shadow extensions in pixels. More...
 
void SetShadow (int radius, int x, int y, Color color)
 Setting the shadow with specified blur radius, axis shifts, shadow color. More...
 
void AddItemState (ItemStateType type, ItemState state)
 Adding visual state for an item. Type can be Base, Hovered, Pressed, Toggled, Focused, Disabled. More...
 
void RemoveItemState (ItemStateType type)
 Removing visual state of an item by type. Type can be Base, Hovered, Pressed, Toggled, Focused, Disabled. More...
 
void RemoveAllItemStates ()
 Removing all item visual states. More...
 
ItemState GetState (ItemStateType type)
 Getting item visual state by its type. Type can be Base, Hovered, Pressed, Toggled, Focused, Disabled. More...
 
virtual void InsertItem (IBaseItem item, Int32 index)
 Inserting item to the container (this). If the count of container elements is less than the index, then the element is added to the end of the list. More...
 
virtual void AddItems (params IBaseItem[] items)
 Adding sequence of items into the container (this). More...
 
virtual void AddItem (IBaseItem item)
 Adding item into the container (this). More...
 
void Update (GeometryEventType type, int value=0)
 Updating an item size or/and position. More...
 
virtual bool IsDrawable ()
 Getting the drawable (visibility) status of an item. This property used in conjunction with the IsVisible() property. Explanation: an item can be visible and invisible, in some cases the item can be located outside the container (example: SpaceVIL.ListBox), and it must be invisible so as not to waste CPU / GPU resources, but in some cases you must control the visibility of elements that are inside container and should be invisible (example: SpaceVIL.TreeView). More...
 
void SetDrawable (bool value)
 Setting the drawable (visibility) status of an item. This property used in conjunction with the IsVisible() property. Explanation: an item can be visible and invisible, in some cases the item can be located outside the container (example: SpaceVIL.ListBox), and it must be invisible so as not to waste CPU / GPU resources, but in some cases you must control the visibility of elements that are inside container and should be invisible (example: SpaceVIL.TreeView). More...
 
virtual bool IsVisible ()
 Getting the visibility status of an item. This property may used in conjunction with the IsDrawable() property. More...
 
virtual void SetVisible (bool value)
 Setting the visibility status of an item. This property may used in conjunction with the IsDrawable() property. More...
 
virtual bool IsPassEvents ()
 Getting boolean value to know if this item can pass further any input events (mouse, keyboard and etc.). Tip: Need for filtering input events. More...
 
bool IsPassEvents (InputEventType e)
 Getting boolean value to know if this item can pass further the specified type of input events (mouse, keyboard and etc.). More...
 
List< InputEventTypeGetPassEvents ()
 Getting all allowed input events. More...
 
List< InputEventTypeGetBlockedEvents ()
 Getting all blocked input events. More...
 
void SetPassEvents (bool value)
 Setting on or off so that this item can pass further any input events (mouse, keyboard and etc.). More...
 
void SetPassEvents (bool value, InputEventType e)
 Setting on or off so that this item can pass further the specified type of input events (mouse, keyboard and etc.). More...
 
void SetPassEvents (bool value, params InputEventType[] events)
 Setting on or off so that this item can pass further the specified types of input events (mouse, keyboard and etc.). More...
 
virtual bool IsDisabled ()
 Returns True if this item is disabled (non-interactive) otherwise returns False. More...
 
virtual void SetDisabled (bool value)
 Setting this item disabled (become non-interactive) or enabled. More...
 
virtual bool IsMouseHover ()
 Returns True if this item is hovered otherwise returns False. More...
 
virtual void SetMouseHover (bool value)
 Setting this item hovered (mouse cursor located within item's shape). More...
 
virtual bool IsMousePressed ()
 Returns True if mouse is pressed on this item (mouse cursor located within item's shape and any of the mouse button is pressed) otherwise False. More...
 
virtual void SetMousePressed (bool value)
 Setting True if you want that mouse is pressed on this item (mouse cursor located within item's shape and any of the mouse button is pressed) otherwise False. More...
 
virtual bool IsFocused ()
 Returns True if this item gets focus otherwise False. More...
 
virtual List< IBaseItemGetItems ()
 Getting list of the Prototype's inner items (children). More...
 
virtual bool RemoveItem (IBaseItem item)
 Removing the specified item from container (this). More...
 
void SetContent (List< IBaseItem > content)
 Setting content for this item. Note: this method is only for sorting children i.e. Prototype.GetItems() contains equal set of children as input argument: List<SpaceVIL.Core.IBaseItem> content. If content is different this method do nothing. More...
 
Figure IsCustomFigure ()
 Getting the custom shape if it is set. You can set any shape using Prototype.SetCustomFigure(Figure) and it will replace the default rectangle shape. More...
 
void SetCustomFigure (Figure figure)
 Setting the custom shape to replace the default rectangle shape. More...
 
ItemHoverRule GetHoverRule ()
 Getting the hovering rule of this item. Can be ItemHoverRule.Lazy or ItemHoverRule.Strict (see SpaceVIL.Core.ItemHoverRule). More...
 
void SetHoverRule (ItemHoverRule rule)
 Setting the hovering rule for this item. More...
 
CursorImage GetCursor ()
 Getting the mouse cursor image of this item. More...
 
void SetCursor (EmbeddedCursor type)
 Setting mouse cursor image for this item from embedded cursors. More...
 
void SetCursor (CursorImage cursor)
 Setting mouse cursor image for this item. More...
 
void SetCursor (Bitmap bitmap)
 Creating and setting mouse cursor image for this item from specified bitmap image. More...
 
void SetCursor (Bitmap bitmap, int width, int height)
 Creating and setting mouse cursor image for this item from specified scaled bitmap image. More...
 

Public Attributes

BlankItem Menu = new BlankItem()
 Interactive item to show the navigation context menu. More...
 
VerticalScrollBar VScrollBar = new VerticalScrollBar()
 Vertical scroll bar of TextArea. More...
 
HorizontalScrollBar HScrollBar = new HorizontalScrollBar()
 Horizontal scroll bar of TextArea. More...
 
EventCommonMethod OnTextChanged
 Event that is invoked when text is changed. More...
 
- Public Attributes inherited from SpaceVIL.Prototype
EventCommonMethodState EventResize
 Event that is invoked when an item is resizing. More...
 
EventCommonMethodState EventDestroy
 Event that is invoked when an item is destroyed (removed). More...
 
EventMouseMethodState EventMouseHover
 Event that is invoked when mouse cursor enters inside an item area. More...
 
EventMouseMethodState EventMouseLeave
 Event that is invoked when mouse cursor leaves inside an item area. More...
 
EventMouseMethodState EventMouseClick
 Event that is invoked when mouse click (release) on an item. More...
 
EventMouseMethodState EventMouseDoubleClick
 Event that is invoked when mouse double click on an item. More...
 
EventMouseMethodState EventMousePress
 Event that is invoked when mouse press on an item. More...
 
EventMouseMethodState EventMouseDrag
 Event that is invoked when mouse drag on an item. More...
 
EventMouseMethodState EventMouseDrop
 Event that is invoked when mouse drop on an item. More...
 
EventMouseMethodState EventScrollUp
 Event that is invoked when mouse wheel scrolls up on an item. More...
 
EventMouseMethodState EventScrollDown
 Event that is invoked when mouse wheel scrolls down on an item. More...
 
EventKeyMethodState EventKeyPress
 Event that is invoked when key of keyboard is pressed. More...
 
EventKeyMethodState EventKeyRelease
 Event that is invoked when key of keyboard is released. More...
 
EventInputTextMethodState EventTextInput
 Event that is invoked when typing text on the keyboard. More...
 
bool IsFocusable = true
 Item's focusable property. True: this item can get focus. False: this item cannot get focus. More...
 

Additional Inherited Members

- Protected Member Functions inherited from SpaceVIL.Prototype
virtual void UpdateState ()
 Updating Prototype's state according to its ItemStateType. More...
 
void SetState (ItemStateType state)
 

Detailed Description

TextArea is a basic implementation of a user interface editable text area.

Contains text area, scroll bars, menu button, navigation context menu.

Supports all events except drag and drop.

Constructor & Destructor Documentation

◆ TextArea() [1/2]

SpaceVIL.TextArea.TextArea ( )

Default TextArea constructor.

◆ TextArea() [2/2]

SpaceVIL.TextArea.TextArea ( String  text)

Constructs TextArea with the specified text.

Parameters
textText for TextArea.

Member Function Documentation

◆ AppendText()

void SpaceVIL.TextArea.AppendText ( String  text)

Adding the specified text to the end of the existing text.

Parameters
textText for adding.

◆ Clear()

override void SpaceVIL.TextArea.Clear ( )
virtual

Deletes all text in the TextArea.

Reimplemented from SpaceVIL.Prototype.

◆ CutText()

string SpaceVIL.TextArea.CutText ( )

Cuts and returns the current selected text.

Returns
Selected text.

◆ DisableMenu()

void SpaceVIL.TextArea.DisableMenu ( bool  value)

Setting the navigation context menu to disable or enable. Default: False.

Parameters
valueTrue: if you want to disable navigation context menu. False: if you want to enable navigation context menu.

◆ GetFont()

Font SpaceVIL.TextArea.GetFont ( )

Getting the current font of the text.

Returns
Font as System.Drawing.Font.

◆ GetForeground()

Color SpaceVIL.TextArea.GetForeground ( )

Getting current text color.

Returns
Text color as System.Drawing.Color.

◆ GetHScrollBarPolicy()

VisibilityPolicy SpaceVIL.TextArea.GetHScrollBarPolicy ( )

Getting horizontal scroll bar visibility policy.

Returns
Visibility policy as SpaceVIL.Core.VisibilityPolicy.

◆ GetLineSpacer()

int SpaceVIL.TextArea.GetLineSpacer ( )

Getting current indent between lines in TextArea.

Returns
Indent between lines.

◆ GetSelectedText()

string SpaceVIL.TextArea.GetSelectedText ( )

Getting the current selected text.

Returns
Current selected text.

◆ GetText()

String SpaceVIL.TextArea.GetText ( )

Getting the current text of the TextArea.

Returns
Text as System.String.

◆ GetTextHeight()

int SpaceVIL.TextArea.GetTextHeight ( )

Getting the text height.

Returns
Text height.

◆ GetTextMargin()

Indents SpaceVIL.TextArea.GetTextMargin ( )

Getting indents of the text.

Returns
Indents as SpaceVIL.Decorations.Indents.

◆ GetTextWidth()

int SpaceVIL.TextArea.GetTextWidth ( )

Getting the text width.

Returns
Text width.

◆ GetVScrollBarPolicy()

VisibilityPolicy SpaceVIL.TextArea.GetVScrollBarPolicy ( )

Getting vertical scroll bar visibility policy.

Returns
Visibility policy as SpaceVIL.Core.VisibilityPolicy.

◆ InitElements()

override void SpaceVIL.TextArea.InitElements ( )
virtual

Initializing all elements in the TextArea. Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually.

Reimplemented from SpaceVIL.Prototype.

◆ IsEditable()

bool SpaceVIL.TextArea.IsEditable ( )

Returns True if TextArea is editable otherwise returns False.

Returns
True: if TextArea is editable. True: if TextArea is non-editable.

◆ IsWrapText()

bool SpaceVIL.TextArea.IsWrapText ( )

Returns True if TextArea wraps the contained text to the width of the TextArea otherwise returns False.

Returns
True: if TextArea wraps the contained text to the width of the TextArea. False: if TextArea does not wraps the contained text.

◆ PasteText()

void SpaceVIL.TextArea.PasteText ( String  text)

Paste the specified text at the current position of the text cursor (or replace the specified text at the current starting position of the selected text).

Parameters
textText to insert.

◆ RewindText()

void SpaceVIL.TextArea.RewindText ( )

Moves text cursor to the text beginning.

◆ SetEditable()

void SpaceVIL.TextArea.SetEditable ( bool  value)

Setting TextArea text field be editable or be non-editable.

Parameters
valueTrue: if you want TextArea be editable. True: if you want TextArea be non-editable.

◆ SetFocus()

override void SpaceVIL.TextArea.SetFocus ( )
virtual

Setting focus on TextArea if it is focusable.

Reimplemented from SpaceVIL.Prototype.

◆ SetFont()

void SpaceVIL.TextArea.SetFont ( Font  font)

Setting font of the text.

Parameters
fontFont as System.Drawing.Font.

◆ SetFontFamily()

void SpaceVIL.TextArea.SetFontFamily ( FontFamily  fontFamily)

Setting new font family of the text.

Parameters
fontFamilyNew font family as System.Drawing.FontFamily.

◆ SetFontSize()

void SpaceVIL.TextArea.SetFontSize ( int  size)

Setting font size of the text.

Parameters
sizeNew size of the font.

◆ SetFontStyle()

void SpaceVIL.TextArea.SetFontStyle ( FontStyle  style)

Setting font style of the text.

Parameters
styleNew font style as System.Drawing.FontStyle.

◆ SetForeground() [1/5]

void SpaceVIL.TextArea.SetForeground ( Color  color)

Setting text color of a TextArea.

Parameters
colorText color as System.Drawing.Color.

◆ SetForeground() [2/5]

void SpaceVIL.TextArea.SetForeground ( float  r,
float  g,
float  b 
)

Setting text color of a TextArea in float RGB format.

Parameters
rRed color component. Range: (0.0f - 1.0f)
gGreen color component. Range: (0.0f - 1.0f)
bBlue color component. Range: (0.0f - 1.0f)

◆ SetForeground() [3/5]

void SpaceVIL.TextArea.SetForeground ( float  r,
float  g,
float  b,
float  a 
)

Setting text color of a TextArea in float RGBA format.

Parameters
rRed color component. Range: (0.0f - 1.0f)
gGreen color component. Range: (0.0f - 1.0f)
bBlue color component. Range: (0.0f - 1.0f)
aAlpha color component. Range: (0.0f - 1.0f)

◆ SetForeground() [4/5]

void SpaceVIL.TextArea.SetForeground ( int  r,
int  g,
int  b 
)

Setting text color of a TextArea in byte RGB format.

Parameters
rRed color component. Range: (0 - 255)
gGreen color component. Range: (0 - 255)
bBlue color component. Range: (0 - 255)

◆ SetForeground() [5/5]

void SpaceVIL.TextArea.SetForeground ( int  r,
int  g,
int  b,
int  a 
)

Setting text color of a TextArea in byte RGBA format.

Parameters
rRed color component. Range: (0 - 255)
gGreen color component. Range: (0 - 255)
bBlue color component. Range: (0 - 255)
aAlpha color component. Range: (0 - 255)

◆ SetHeight()

override void SpaceVIL.TextArea.SetHeight ( int  height)
virtual

Setting item height. If the value is greater/less than the maximum/minimum value of the height, then the height becomes equal to the maximum/minimum value.

Parameters
heightHeight of the item.

Reimplemented from SpaceVIL.Prototype.

◆ SetHScrollBarPolicy()

void SpaceVIL.TextArea.SetHScrollBarPolicy ( VisibilityPolicy  policy)

Setting horizontal scroll bar visibility policy. Default: SpaceVIL.Core.VisibilityPolicy.AsNeeded.

Parameters
policyVisibility policy as SpaceVIL.Core.VisibilityPolicy.

◆ SetLineSpacer()

void SpaceVIL.TextArea.SetLineSpacer ( int  lineSpacer)

Setting indent between lines in TextArea.

Parameters
lineSpacerIndent between lines.

◆ SetScrollStepFactor()

void SpaceVIL.TextArea.SetScrollStepFactor ( float  value)

Setting scroll step factor. The scroll factor determines how many lines are scrolled in a single scroll request (using a button or mouse wheel). Default: 1.0

Parameters
valueScroll step factor.

◆ SetStyle()

override void SpaceVIL.TextArea.SetStyle ( Style  style)
virtual

Setting style of the TextArea. Inner styles: "vscrollbar", "hscrollbar", "textedit", "menu".

Parameters
styleStyle as SpaceVIL.Decorations.Style.

Reimplemented from SpaceVIL.Prototype.

◆ SetText()

void SpaceVIL.TextArea.SetText ( String  text)

Setting the text.

Parameters
textText as System.String.

◆ SetTextMargin() [1/2]

void SpaceVIL.TextArea.SetTextMargin ( Indents  margin)

Setting indents for the text to offset text relative to this TextArea.

Parameters
marginIndents as SpaceVIL.Decorations.Indents.

◆ SetTextMargin() [2/2]

void SpaceVIL.TextArea.SetTextMargin ( int  left = 0,
int  top = 0,
int  right = 0,
int  bottom = 0 
)

Setting indents for the text to offset text relative to TextArea.

Parameters
leftIndent on the left.
topIndent on the top.
rightIndent on the right.
bottomIndent on the bottom.

◆ SetVScrollBarPolicy()

void SpaceVIL.TextArea.SetVScrollBarPolicy ( VisibilityPolicy  policy)

Setting vertical scroll bar visibility policy. Default: SpaceVIL.Core.VisibilityPolicy.AsNeeded.

Parameters
policyVisibility policy as SpaceVIL.Core.VisibilityPolicy.

◆ SetWidth()

override void SpaceVIL.TextArea.SetWidth ( int  width)
virtual

Setting item width. If the value is greater/less than the maximum/minimum value of the width, then the width becomes equal to the maximum/minimum value.

Parameters
widthWidth of the item.

Reimplemented from SpaceVIL.Prototype.

◆ SetWrapText()

void SpaceVIL.TextArea.SetWrapText ( bool  value)

Setting TextArea mode that wraps (or not wraps) input text to the width of the TextArea.

Parameters
valueTrue: if you want to TextArea wraps the contained text to the width of the TextArea. False: if you want to TextArea does not wraps the contained text.

Member Data Documentation

◆ HScrollBar

HorizontalScrollBar SpaceVIL.TextArea.HScrollBar = new HorizontalScrollBar()

Horizontal scroll bar of TextArea.

◆ Menu

BlankItem SpaceVIL.TextArea.Menu = new BlankItem()

Interactive item to show the navigation context menu.

◆ OnTextChanged

EventCommonMethod SpaceVIL.TextArea.OnTextChanged

Event that is invoked when text is changed.

◆ VScrollBar

VerticalScrollBar SpaceVIL.TextArea.VScrollBar = new VerticalScrollBar()

Vertical scroll bar of TextArea.


The documentation for this class was generated from the following file: