RegionBase Class

Base class for every worksheet Region.

Definition

Namespace: SMath.Controls
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.73.9126.0
C#
public abstract class RegionBase : IDocumentObject, 
	IComparable<RegionBase>, IRegionInternal
Inheritance
Object    RegionBase
Derived
Implements
IDocumentObject, IRegionInternal, IComparable<RegionBase>

Constructors

RegionBase(RegionBase) Constructs a copy of the specified instance of RegionBase.
RegionBase(SessionProfile) Constructs an instance of RegionBase with default values.

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 Stores the child regions of the region.
Container The parent region which contains this region.
ContainsFields Determines if the current Region contains fields inside.
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 List of assemblies the region depends on.
DrawBase Determines whether standard logic of painting should not be applied for current region.
FixedLayout Determines 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 URL to show as an anchor for the region.
Location Location of the document element.
MetaData Metadata for the region.
Middle Returns the value of MiddleLine.
Obsolete.
MiddleLine Gets middle line for the Region.
PageBreaks Determines a list of y-coordinates where current RegionBase instance can be safely splitted for the page breaks.
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 Profile of session the region is created for.
Size Size of the document element.
TabStop Determines if the current region supports stops by keyboard TAB button.
TextColor The text color of the element.
UniqueId Unique Id of the Region.

Methods

BeforeCopy Copies content of the current RegionBase or its children Regions to the Clipboard.
BeforePaste Paste content of the current RegionBase or its children Regions to the Clipboard.
ChangeLocation Safely change element position (the old and new positions of the element on the sheet are redrawn).
ChangeStatus(String) Raises the StatusChanged event.
ChangeStatus(String, Int32, Int32, Stopwatch) Raises the StatusChanged and ProgressChanged events.
ChildRepainting Invalidates container region.
ClickMenuButton Emulates a menu button click.
Clone Creates a new document element that is a copy of the current instance.
Copy Copies content of the current RegionBase or its part to the Clipboard.
CreateHistoryStep Registrates Region changes into changes history.
Dispose Disposes of the region data.
Draw Draws a document element on the given canvas with a specified model of page.
DrawToBitmap() Getting element image.
DrawToBitmap(IGraphics) Draws the region at its default location.
DrawToBitmap(Color, Boolean) Getting an element image with the specified background color.
DrawToBitmap(IGraphics, Point) Draws the region with the specified offset added to Location.
DrawToBitmapScaled Draws current region to the IBitmap.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows 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.
GetAllChildren Returns a list of children region to the current.
GetCursorType Defines a cursor type by pointer location.
GetFocusedPart Returns currently focused child of the Region or the Region itself.
GetHashCodeServes as the default hash function.
(Overrides Object.GetHashCode())
GetHistoryStep Creates a new instance of HistoryStepBase for this region.
GetSelectionStatus Determines the selection status of the region contents.
GetTypeGets the Type of the current instance.
(Inherited from Object)
InitLayout Initializes layout of the region.
Invalidate Determines the absolute coordinates of the control's position and sends a request to redraw it.
IsEmpty Determines whether the current region has no any data inside.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
OnBeforeCommandSend Handles given text command by the current RegionBase or its children Regions.
OnCommandSend Handles given text command by the current RegionBase.
OnKeyDown Handles KeyDown event.
OnKeyPress Handles KeyPress event.
OnKeyUp Handles KeyUp event.
OnMouseDown Handles MouseDown event.
OnMouseMove Handles MouseMove event.
OnMouseUp Handles MouseUp event.
OnMouseWheel Handles MouseWheel event.
OnPaint Handles Paint event.
OnSelectionUpdate Handles selection update send from the parent container.
Paste Paste content of the current RegionBase or its part to the Clipboard.
PrePainter() Prepares a Region for the future drawing. Actualizes internal fields and initializes a region if needed.
PrePainter(IGraphics) Refreshs the content of the current RegionBase to apply possible changes before drawing.
ReadyToChangeLocation Does nothing.
Obsolete.
ReadyToPaint Does nothing.
Obsolete.
ResetColors Safe apply of colors (all color-dependent variables are updated).
Resize Generates a resize event.
ShowAvailableTermsList Raises the AvailableTermsListShow event unless CurrentContentPlacement of Parent is equal to Header or Footer.
ToStringReturns a string that represents the current object.
(Inherited from Object)
ToXml Writes the region to XML on save of the document.

Events

AvailableTermsListShow Occurs when autocompletion list is shown.
BeforeLocationChanged Occurs before change of location of the region.
Changed Occurs when the region is changed and that change is tracked in history.
FocusChanged Occurs when the value of Focused property is changed.
MenuButtonClick Occurs when a menu button click emulated within current RegionBase.
PaintRequested Occurs when repaint of region is requested.
ProgressChanged Occurs when the long time operation progress changed within current RegionBase.
Resized Occurs when the size of region is changed.
StatusChanged Occurs when the status of region is changed.

Fields

brush Array of brushes, used for drawing.
dblclick A timer used to detect if current operation initiated by pointer double-click.
pen Array of pens, used for drawing.
referer Text action name of the last change in the Region.

Explicit Interface Implementations

IComparable<RegionBase>.CompareToCompares 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.
IRegionInternal.InvokeGetCursorType Calls GetCursorType(MouseEventOptions) with respect to the child regions.
IRegionInternal.IsPointInRegion Checks whether the specified point is within the region.
IRegionInternal.OnBeforeMouseDown Pre-handles the MouseDown event for the region.
IRegionInternal.OnBeforeMouseMove Pre-handles the MouseMove event for the region.
IRegionInternal.OnBeforeMouseUp Pre-handles the MouseUp event for the region.

See Also