SMath Studio Core documentation
Region
Base class for every worksheet Region.
Definition
Namespace: SMath.Controls
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.2.9018.0
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.2.9018.0
C#
public abstract class RegionBase : IDocumentObject,
IComparable<RegionBase>VB
Public MustInherit Class RegionBase
Implements IDocumentObject, IComparable(Of RegionBase)C++
public ref class RegionBase abstract : IDocumentObject,
IComparable<RegionBase^>F#
[<AbstractClassAttribute>]
type RegionBase =
class
interface IDocumentObject
interface IComparable<RegionBase>
end- Inheritance
- Object RegionBase
- Derived
- Implements
- IDocumentObject, IComparableRegionBase
Constructors
| RegionBase(RegionBase) | Constructor to copy Region to a new instance. |
| RegionBase(SessionProfile) | Empty Region constructor. |
Properties
| BackColor | Element background color. |
| BaseLine | Gets base line for the Region. |
| BaseSize | Size of the base part of the Region. |
| Border | Draws a frame along the border of an element. |
| Bottom | Bottom element boundary. |
| Children | |
| Container | |
| ContainsFields | |
| CurrentCollapsedHeight | Height of the document collapsed area before current document element. |
| CurrentCursorLocation | Returns cursor location within current Region. |
| CurrentMetaContext | Gets or sets variables to use for document fields in the context of current document. |
| CurrentPageOffsets | Offsets of the current document page where the document element is present. |
| Dependences | |
| DrawBase | |
| FixedLayout | Defines if modeling options of the Region could be modified. |
| 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). |
| Font | Font, used by the element. |
| FontHeight | The size of the font used by the element. |
| Id | Id of the current RegionBase instance. |
| InnerBounds | Bounds of the content Region area relative to the Worksheet. |
| IsActivated | Determines whether the document element is activated and registered on the worksheet. |
| IsIntegratedRegion | Determines whether Region is integarted as an important part of another Rerion or not. |
| Link | |
| Location | Location of the document element. |
| MetaData | |
| Middle | Obsolete. |
| MiddleLine | Gets middle line for the Region. |
| PageBreaks | |
| Parent | Gets the Worksheet where Region exists. |
| Regions | Children of the current Region. |
| RemoteOwner | Name of the remote owner client. Must be empty if Region belongs to local user. |
| Right | Right element boundary. |
| Selected | Determines whether the document element is selected within the Worksheet. |
| SelectedBackColor | Selected background color. |
| SelectedTextColor | The color of the element's selected text. |
| SessionProfile | |
| Size | Size of the document element. |
| TabStop | |
| TextColor | The text color of the element. |
| UniqueId | Unique Id of the Region. |
Methods
| BeforeCopy | |
| BeforePaste | |
| ChangeLocation | Safely change element position (the old and new positions of the element on the sheet are redrawn). |
| ChangeStatus(String) | |
| ChangeStatus(String, Int32, Int32, Stopwatch) | |
| ChildRepainting | |
| ClickMenuButton | |
| Clone | Creates a new document element that is a copy of the current instance. |
| Copy | |
| CreateHistoryStep | Registrates Region changes into changes history. |
| Dispose | Releases all resources used by the RegionBase |
| Draw | Draws a document element on the given canvas with a specified model of page. |
| DrawToBitmap | Getting element image. |
| DrawToBitmap(IGraphics) | |
| DrawToBitmap(Color, Boolean) | Getting an element image with the specified background color. |
| DrawToBitmap(IGraphics, Point) | Drawing of the Region on the specified location. |
| DrawToBitmapScaled | |
| 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 | |
| GetAllChildren | |
| GetCursorType | Defines a cursor type by pointer location. |
| GetFocusedPart | |
| GetHashCode | (Overrides ObjectGetHashCode) |
| GetHistoryStep | |
| GetSelectionStatus | |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| InitLayout | |
| Invalidate | Determines the absolute coordinates of the control's position and sends a request to redraw it. |
| IsEmpty | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnBeforeCommandSend | |
| OnCommandSend | |
| OnKeyDown | |
| OnKeyPress | |
| OnKeyUp | |
| OnMouseDown | |
| OnMouseMove | |
| OnMouseUp | |
| OnMouseWheel | |
| OnPaint | |
| OnSelectionUpdate | |
| Paste | |
| PrePainter | Prepares a Region for the future drawing. Actualizes internal fields and initializes a region if needed. |
| PrePainter(IGraphics) | |
| ReadyToChangeLocation | Obsolete. |
| ReadyToPaint | Obsolete. |
| ResetColors | Safe apply of colors (all color-dependent variables are updated). |
| Resize | Generates a resize event. |
| ShowAvailableTermsList | |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| ToXml |
Events
| AvailableTermsListShow | |
| BeforeLocationChanged | |
| Changed | |
| FocusChanged | |
| MenuButtonClick | |
| PaintRequested | |
| ProgressChanged | |
| Resized | |
| StatusChanged |
Fields
| brush | Array of brushes, used for drawing. |
| dblclick | |
| pen | Array of pens, used for drawing. |
| referer |
Text action name of the last change in the Region.
Obsolete. |
Explicit Interface Implementations
| IComparableRegionBaseCompareTo | Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. |