SMath Studio Core documentation
Region
Base class which supports translation of the inherited Regions.
Definition
Namespace: SMath.Controls
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.73.9126.0
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.73.9126.0
C#
public abstract class RegionTranslatable : RegionBaseVB
Public MustInherit Class RegionTranslatable
Inherits RegionBaseC++
public ref class RegionTranslatable abstract : public RegionBaseF#
[<AbstractClassAttribute>]
type RegionTranslatable =
class
inherit RegionBase
end- Inheritance
- Object RegionBase RegionTranslatable
Constructors
| RegionTranslatable(RegionTranslatable) | Constructs a copy of the specified instance of RegionTranslatable. |
| RegionTranslatable(SessionProfile) | Constructs an instance of RegionTranslatable with default values. |
Properties
| AvailableLanguages | All languages for which translations are added. |
| BackColor |
Element background color.
(Inherited from RegionBase) |
| BaseLine |
Gets base line for the Region.
(Inherited from RegionBase) |
| BaseSize |
Size of the base part of the Region.
(Inherited from RegionBase) |
| Border |
Draws a frame along the border of an element.
(Inherited from RegionBase) |
| Bottom |
Bottom element boundary.
(Inherited from RegionBase) |
| Children |
Stores the child regions of the region.
(Inherited from RegionBase) |
| Container |
The parent region which contains this region.
(Inherited from RegionBase) |
| ContainsFields |
Determines if the current Region contains fields inside.
(Inherited from RegionBase) |
| CurrentCollapsedHeight |
Height of the document collapsed area before current document element.
(Inherited from RegionBase) |
| CurrentCursorLocation |
Returns cursor location within current Region.
(Inherited from RegionBase) |
| CurrentLanguage | Language which is currently active. |
| CurrentMetaContext |
Gets or sets variables to use for document fields in the context of current document.
(Inherited from RegionBase) |
| CurrentPageOffsets |
Offsets of the current document page where the document element is present.
(Inherited from RegionBase) |
| Dependences |
List of assemblies the region depends on.
(Inherited from RegionBase) |
| DrawBase |
Determines whether standard logic of painting should not be applied for current region.
(Inherited from RegionBase) |
| FixedLayout |
Determines if modeling options of the Region could be modified.
(Inherited from RegionBase) |
| Focused |
Determines whether the element is in the editing mode or not. If true, the element is highlighted with a frame and gets the
right to place the cursor in it. The frame color is determined by the relevance of the element's information (InDate property).
(Inherited from RegionBase) |
| Font |
Font, used by the element.
(Inherited from RegionBase) |
| FontHeight |
The size of the font used by the element.
(Inherited from RegionBase) |
| Id |
Id of the current RegionBase instance.
(Inherited from RegionBase) |
| InnerBounds |
Bounds of the content Region area relative to the Worksheet.
(Inherited from RegionBase) |
| IsActivated |
Determines whether the document element is activated and registered on the worksheet.
(Inherited from RegionBase) |
| IsIntegratedRegion |
Determines whether Region is integarted as an important part of another Rerion or not.
(Inherited from RegionBase) |
| Link |
URL to show as an anchor for the region.
(Inherited from RegionBase) |
| Location |
Location of the document element.
(Inherited from RegionBase) |
| MetaData |
Metadata for the region.
(Inherited from RegionBase) |
| Middle |
Returns the value of MiddleLine.
(Inherited from RegionBase) Obsolete. |
| MiddleLine |
Gets middle line for the Region.
(Inherited from RegionBase) |
| PageBreaks |
Determines a list of y-coordinates where current RegionBase instance
can be safely splitted for the page breaks.
(Inherited from RegionBase) |
| Parent |
Gets the Worksheet where Region exists.
(Inherited from RegionBase) |
| Regions |
Children of the current Region.
(Inherited from RegionBase) |
| RemoteOwner |
Name of the remote owner client. Must be empty if Region belongs to local user.
(Inherited from RegionBase) |
| Right |
Right element boundary.
(Inherited from RegionBase) |
| Selected |
Determines whether the document element is selected within the Worksheet.
(Inherited from RegionBase) |
| SelectedBackColor |
Selected background color.
(Inherited from RegionBase) |
| SelectedTextColor |
The color of the element's selected text.
(Inherited from RegionBase) |
| SessionProfile |
Profile of session the region is created for.
(Inherited from RegionBase) |
| Size |
Size of the document element.
(Inherited from RegionBase) |
| TabStop |
Determines if the current region supports stops by keyboard TAB button.
(Inherited from RegionBase) |
| TextColor |
The text color of the element.
(Inherited from RegionBase) |
| UniqueId |
Unique Id of the Region.
(Inherited from RegionBase) |
Methods
| BeforeCopy |
Copies content of the current RegionBase or its children Regions to the Clipboard.
(Inherited from RegionBase) |
| BeforePaste |
Paste content of the current RegionBase or its children Regions to the Clipboard.
(Inherited from RegionBase) |
| ChangeLocation |
Safely change element position (the old and new positions of
the element on the sheet are redrawn).
(Inherited from RegionBase) |
| ChangeStatus(String) |
Raises the StatusChanged event.
(Inherited from RegionBase) |
| ChangeStatus(String, Int32, Int32, Stopwatch) |
Raises the StatusChanged and ProgressChanged events.
(Inherited from RegionBase) |
| ChildRepainting |
Invalidates container region.
(Inherited from RegionBase) |
| ClickMenuButton |
Emulates a menu button click.
(Inherited from RegionBase) |
| Clone |
Creates a new document element that is a copy of the current instance.
(Inherited from RegionBase) |
| ContainsTranslationValue | Determines whether a translation for the specified language exists. |
| Copy |
Copies content of the current RegionBase or its part to the Clipboard.
(Inherited from RegionBase) |
| CreateHistoryStep |
Registrates Region changes into changes history.
(Inherited from RegionBase) |
| Dispose |
Disposes of the region data.
(Inherited from RegionBase) |
| Draw |
Draws a document element on the given canvas with a specified model of page.
(Inherited from RegionBase) |
| DrawToBitmap |
Getting element image.
(Inherited from RegionBase) |
| DrawToBitmap(IGraphics) |
Draws the region at its default location.
(Inherited from RegionBase) |
| DrawToBitmap(Color, Boolean) |
Getting an element image with the specified background color.
(Inherited from RegionBase) |
| DrawToBitmap(IGraphics, Point) |
Draws the region with the specified offset added to Location.
(Inherited from RegionBase) |
| DrawToBitmapScaled |
Draws current region to the IBitmap.
(Inherited from RegionBase) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| FromXml |
Reads the region from XML on load of the document.
(Inherited from RegionBase) |
| GetAllChildren |
Returns a list of children region to the current.
(Overrides RegionBaseGetAllChildren) |
| GetCursorType |
Defines a cursor type by pointer location.
(Inherited from RegionBase) |
| GetFocusedPart |
Returns currently focused child of the Region or the Region itself.
(Inherited from RegionBase) |
| GetHashCode | Serves as the default hash function. (Inherited from RegionBase) |
| GetHistoryStep |
Creates a new instance of HistoryStepBase for this region.
(Inherited from RegionBase) |
| GetSelectionStatus |
Determines the selection status of the region contents.
(Inherited from RegionBase) |
| GetTranslation | Attempts to get a translation for the specified language. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| InitLayout |
Initializes layout of the region.
(Inherited from RegionBase) |
| Invalidate |
Determines the absolute coordinates of the control's position and
sends a request to redraw it.
(Inherited from RegionBase) |
| IsEmpty |
Determines whether the current region has no any data inside.
(Inherited from RegionBase) |
| LanguageChange | Applies the specified translation value to the region after change of language. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnBeforeCommandSend |
Handles given text command by the current RegionBase or its children Regions.
(Inherited from RegionBase) |
| OnCommandSend |
Handles given text command by the current RegionBase.
(Inherited from RegionBase) |
| OnKeyDown |
Handles KeyDown event.
(Inherited from RegionBase) |
| OnKeyPress |
Handles KeyPress event.
(Inherited from RegionBase) |
| OnKeyUp |
Handles KeyUp event.
(Inherited from RegionBase) |
| OnMouseDown |
Handles MouseDown event.
(Inherited from RegionBase) |
| OnMouseMove |
Handles MouseMove event.
(Inherited from RegionBase) |
| OnMouseUp |
Handles MouseUp event.
(Inherited from RegionBase) |
| OnMouseWheel |
Handles MouseWheel event.
(Inherited from RegionBase) |
| OnPaint |
Handles Paint event.
(Inherited from RegionBase) |
| OnSelectionUpdate |
Handles selection update send from the parent container.
(Inherited from RegionBase) |
| Paste |
Paste content of the current RegionBase or its part to the Clipboard.
(Inherited from RegionBase) |
| PrePainter |
Prepares a Region for the future drawing. Actualizes internal
fields and initializes a region if needed.
(Inherited from RegionBase) |
| PrePainter(IGraphics) |
Refreshs the content of the current RegionBase to apply possible changes before drawing.
(Inherited from RegionBase) |
| ReadyToPaint |
Does nothing.
(Inherited from RegionBase) Obsolete. |
| RemoveCurrentValue | Removes the translation for CurrentLanguage unless it is the last translation and swtches the language via SetCurrentValue. |
| ResetColors |
Safe apply of colors (all color-dependent variables are updated).
(Inherited from RegionBase) |
| Resize |
Generates a resize event.
(Inherited from RegionBase) |
| SetCurrentValue | Determines the proper language according to CurrentLanguage and available translations, then switches to it via ShowTranslationValue(String). |
| SetTranslationValue(Object) | Sets the translation value for CurrentLanguage. |
| SetTranslationValue(Object, String) | Changes CurrentLanguage to the specified language and sets the specified translation value. |
| ShowAvailableTermsList |
Raises the AvailableTermsListShow event unless CurrentContentPlacement
of Parent is equal to Header or Footer.
(Inherited from RegionBase) |
| ShowTranslationValue | Activates value by the specified language. Creates an empty entry if no translation exists. |
| ToString | Returns a string that represents the current object. (Overrides ObjectToString) |
| ToXml |
Writes the region to XML on save of the document.
(Inherited from RegionBase) |
Events
| AvailableTermsListShow |
Occurs when autocompletion list is shown.
(Inherited from RegionBase) |
| BeforeLocationChanged |
Occurs before change of location of the region.
(Inherited from RegionBase) |
| Changed |
Occurs when the region is changed and that change is tracked in history.
(Inherited from RegionBase) |
| FocusChanged |
Occurs when the value of Focused property is changed.
(Inherited from RegionBase) |
| MenuButtonClick |
Occurs when a menu button click emulated within current RegionBase.
(Inherited from RegionBase) |
| onValueLanguageChanged | Invoked from ShowTranslationValue(String). |
| PaintRequested |
Occurs when repaint of region is requested.
(Inherited from RegionBase) |
| ProgressChanged |
Occurs when the long time operation progress changed within current RegionBase.
(Inherited from RegionBase) |
| Resized |
Occurs when the size of region is changed.
(Inherited from RegionBase) |
| StatusChanged |
Occurs when the status of region is changed.
(Inherited from RegionBase) |
Fields
| brush |
Array of brushes, used for drawing.
(Inherited from RegionBase) |
| dblclick |
A timer used to detect if current operation initiated by pointer double-click.
(Inherited from RegionBase) |
| pen |
Array of pens, used for drawing.
(Inherited from RegionBase) |
| referer |
Text action name of the last change in the Region.
(Inherited from RegionBase) |