RegionHolder<T> Class

Region Holder class that implements support for custom Region canvas to be wrapped by the Evaluable Region which supports all the features of the program. It provides built-in Math Region located next to the custom Region.

Definition

Namespace: SMath.Controls
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.73.9126.0

C#
public abstract class RegionHolder<T> : RegionEvaluable, 
	IRegionWithEditableText, IRegionWithInputData, IRegionWithTooltip, IRegionWithExtendedSearch
where T : RegionEvaluable

VB
Public MustInherit Class RegionHolder(Of T As RegionEvaluable)
	Inherits RegionEvaluable
	Implements IRegionWithEditableText, IRegionWithInputData, IRegionWithTooltip, IRegionWithExtendedSearch

C++
generic<typename T>
where T : RegionEvaluable
public ref class RegionHolder abstract : public RegionEvaluable, 
	IRegionWithEditableText, IRegionWithInputData, IRegionWithTooltip, IRegionWithExtendedSearch

F#
[<AbstractClassAttribute>]
type RegionHolder<'T when 'T : RegionEvaluable> = 
    class
        inherit RegionEvaluable
        interface IRegionWithEditableText
        interface IRegionWithInputData
        interface IRegionWithTooltip
        interface IRegionWithExtendedSearch
    end

Inheritance: Object RegionBase RegionEvaluable RegionHolder<T>

Implements: IRegionWithEditableText, IRegionWithExtendedSearch, IRegionWithInputData, IRegionWithTooltip

Type Parameters

T: Type of the Custom Region which is to be used as a main graphical representation of the result Region.

Constructors

RegionHolder<T>(RegionHolder<T>)	Constructs a copy of the specified instance of RegionHolder<T>.
RegionHolder<T>(SessionProfile)	Constructs an instance of RegionHolder<T> with default values.

Properties

ActiveDebugTermIndex	Determines an index of the Term which is shown as an active expression entry in the debugging session. (Inherited from RegionEvaluable)
BackColor	Element background color. (Overrides RegionBase.BackColor)
BaseLine	Gets base line for the Region. (Inherited from RegionBase)
BaseSize	Size of the base part of the Region. (Overrides RegionEvaluable.BaseSize)
Border	Draws a frame along the border of an element. (Inherited from RegionBase)
Bottom	Bottom element boundary. (Inherited from RegionBase)
canv	Custom Region which is to be used as a main graphical representation of the result Region.
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. (Overrides RegionEvaluable.CurrentCursorLocation)
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)
CurrentTermIndexes	Indexes of the inner content to determine current cursor position. (Overrides RegionEvaluable.CurrentTermIndexes)
CursorPosition	Current position (offset) of text cursor in the region.
DebugTerms	Determines dictionary of the Term and their relative locations which are set as breakpoints. (Inherited from RegionEvaluable)
DeletedValues	List of IPrimitive entries remmoved from the evaluation context during calculation process in the scope of current region. (Inherited from RegionEvaluable)
Dependences	List of assemblies the region depends on. (Overrides RegionBase.Dependences)
DescriptionBounds	Determines the bounding rectange of Description according to ShowDescription and DescriptionLocation. If ShowDescription is false then returns an empty rectangle. (Inherited from RegionEvaluable)
DescriptionLocation	Specifies the location of Description. (Inherited from RegionEvaluable)
DescriptionText	Returns the value of ToString() for Description. If Description is null then returns Empty. (Inherited from RegionEvaluable)
DrawBase	Determines whether standard logic of painting should not be applied for current region. (Inherited from RegionBase)
ErrorId	The identifier of the error that occurred within the element. (Inherited from RegionEvaluable)
ErrorTerm	Index of term where evaluation error is found. (Overrides RegionEvaluable.ErrorTerm)
ErrorText	Error text of the element. (Overrides RegionEvaluable.ErrorText)
Evaluable	Gets or sets value defines if the Region is valuable or not. (Inherited from RegionEvaluable)
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). (Overrides RegionEvaluable.Focused)
Font	Font, used by the element. (Inherited from RegionBase)
FontHeight	The size of the font used by the element. (Overrides RegionBase.FontHeight)
Id	Id of the current RegionBase instance. (Inherited from RegionBase)
ImmediateEvaluationOnCanvasRequest	Determines whether the evaluation is required imediately after requested by the canvas of the Region or not.
InDate	Determines whether the content of an element is up-to-date and whether all of the element's components are in sync with each other. (Inherited from RegionEvaluable)
InEvaluation	Gets or sets whether Region is under evaluation now. (Inherited from RegionEvaluable)
InnerBounds	Bounds of the content Region area relative to the Worksheet. (Inherited from RegionEvaluable)
InputDataVisibility	Gets or sets status of the input data visibility.
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)
math	Built-in Math Region placed next to the custom Region.
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. (Overrides RegionEvaluable.MiddleLine)
MinimumSize	Determines a minimum size of the RegionHolder<T>.
Optimization	Optimization type for evaluation of the region. (Inherited from RegionEvaluable)
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)
ResizeBounds	Resize bounds of the Region's canvas.
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)
SelectedTermsIndexes	Indexes of the inner content to determine currently selected content part. (Overrides RegionEvaluable.SelectedTermsIndexes)
SelectedTextColor	The color of the element's selected text. (Inherited from RegionBase)
SessionProfile	Profile of session the region is created for. (Inherited from RegionBase)
ShowDescription	Specifies whether to show or hide Description. (Inherited from RegionEvaluable)
Size	The size of the control. (Overrides RegionEvaluable.Size)
TabStop	Determines if the current region supports stops by keyboard TAB button. (Inherited from RegionBase)
Terms	An array of elements of a mathematical expression. (Overrides RegionEvaluable.Terms)
TextColor	The text color of the element. (Overrides RegionBase.TextColor)
UniqueId	Unique Id of the Region. (Inherited from RegionBase)
Values	List of Definition object contains data about math defenitions added in the scope of current region. (Inherited from RegionEvaluable)
WarningColor	The color of the element's warnings. (Inherited from RegionEvaluable)

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)
CheckEvaluability	Checks if it is required to recalculate page due to the element. (Overrides RegionEvaluable.CheckEvaluability())
ChildRepainting	Invalidates container region. (Inherited from RegionEvaluable)
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)
Copy	Copies content of the current RegionBase or its part to the Clipboard. (Overrides RegionEvaluable.Copy(IClipboardManager))
CreateDescription	Creates Description unless it is already present. (Inherited from RegionEvaluable)
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. (Overrides RegionBase.FromXml(StorageReader, FileParsingContext))
GetAllChildren	Returns a list of children region to the current. (Inherited from RegionBase)
GetCanvas	Returns a canvas of the RegionHolder<T>.
GetcurrentTermsContainer	Returns region container for the region. Provides a reference to the container region of the current child region, points to region itself otherwise. (Inherited from RegionEvaluable) Obsolete.
GetCurrentTermsContainer	Returns region container for the region. Provides a reference to the container region of the current child region, points to region itself otherwise. (Overrides RegionEvaluable.GetCurrentTermsContainer())
GetCursorType	Defines a cursor type by pointer location. (Overrides RegionEvaluable.GetCursorType(MouseEventOptions))
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. (Overrides RegionEvaluable.GetHistoryStep())
GetSelectionStatus	Determines the selection status of the region contents. (Overrides RegionBase.GetSelectionStatus())
GetType	Gets the Type of the current instance. (Inherited from Object)
InitLayout()	Initializes layout of the region. (Inherited from RegionEvaluable)
InitLayout(Store)	Initializes layout of the region with regards to a given store. (Inherited from RegionEvaluable)
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. (Overrides RegionBase.IsEmpty())
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(String)	Handles given text command by the current RegionBase. (Overrides RegionEvaluable.OnCommandSend(String))
OnCommandSend(Term[])	Handles input given by value. (Overrides RegionEvaluable.OnCommandSend(Term[]))
OnEvaluation	Processing of the Plot Regions. (Overrides RegionEvaluable.OnEvaluation(Store))
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. (Overrides RegionEvaluable.OnMouseDown(MouseEventOptions))
OnMouseMove	Handles MouseMove event. (Overrides RegionEvaluable.OnMouseMove(MouseEventOptions))
OnMouseUp	Handles MouseUp event. (Overrides RegionEvaluable.OnMouseUp(MouseEventOptions))
OnMouseWheel	Handles MouseWheel event. (Overrides RegionBase.OnMouseWheel(MouseEventOptions, Int32))
OnMouseWheelAction	Handles action performed by mouse wheel.
OnPaint	Handles Paint event. (Overrides RegionEvaluable.OnPaint(PaintEventOptions))
OnSelectionUpdate	Handles selection update send from the parent container. (Inherited from RegionBase)
OnSizeChanged	Handles Region's size changing.
Paste	Paste content of the current RegionBase or its part to the Clipboard. (Overrides RegionEvaluable.Paste(IClipboardManager))
PrePainter()	Prepares a Region for the future drawing. Actualizes internal fields and initializes a region if needed. (Overrides RegionBase.PrePainter())
PrePainter(IGraphics)	Refreshs the content of the current RegionBase to apply possible changes before drawing. (Inherited from RegionBase)
ReadMath	Reads the mathematical expression from XML on load of the document. (Inherited from RegionEvaluable)
ReadXmlProperties	Reads additional properties of the region from XML on load of the document. (Inherited from RegionEvaluable)
ReadyToPaint	Does nothing. (Inherited from RegionBase) Obsolete.
RequestEntryInfo	Requests displaying information about currently selected math expression element. (Inherited from RegionEvaluable)
RequestEvaluation	Requests Worksheet to perform evaluation starting from the current Region. (Overrides RegionEvaluable.RequestEvaluation(Boolean))
RequestForEvaluation	Invokes RequestEvaluation(Boolean) with immediate argument equal to true. (Inherited from RegionEvaluable) Obsolete.
ResetColors	Safe apply of colors (all color-dependent variables are updated). (Inherited from RegionBase)
Resize	Generates a resize event. (Inherited from RegionBase)
SetEvaluationState	Sets the evaluation state. (Inherited from RegionEvaluable)
SetSize	Sets the size of the Region's canvas.
ShowAvailableTermsList	Raises the AvailableTermsListShow event unless CurrentContentPlacement of Parent is equal to Header or Footer. (Inherited from RegionBase)
ShowError(Exception, IPrimitive)	Reports an error in an element during evaluation. (Inherited from RegionEvaluable)
ShowError(Exception, Term)	Reports an error in an element during evaluation. (Inherited from RegionEvaluable)
ToString	Returns a string that represents the current object. (Overrides Object.ToString())
ToXml	Writes the region to XML on save of the document. (Overrides RegionBase.ToXml(StorageWriter, FileParsingContext))
TrySearch	Looks for the specified value within the region.
WriteMath	Writes the mathematical expression to XML on save of the document. (Inherited from RegionEvaluable)
WriteXmlProperties	Writes additional properties of the region to XML on save of the document. (Inherited from RegionEvaluable)

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)
ErrorOccured	Occurs when an error occurs in this region during evaluation. (Inherited from RegionEvaluable)
EvaluationRequest	Occurs when start of evaluation from this region is requested. (Inherited from RegionEvaluable)
EvaluationStateChanged	Occurs when the evaluation state of the region is changed. (Inherited from RegionEvaluable)
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)
OnEntryInfoRequested	Occurs when information about dimension is requested. (Inherited from RegionEvaluable)
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)
Description	Provides additional description for the region which is shown near the mathematical expression. (Inherited from RegionEvaluable)
pen	Array of pens, used for drawing. (Inherited from RegionBase)
referer	Text action name of the last change in the Region. (Inherited from RegionBase)
terms	Array of Term represents mathematical expression. (Inherited from RegionEvaluable)

Explicit Interface Implementations

IRegionWithEditableText.SerializedValue	Serialized value of the region.
IRegionWithEditableText.SetPreviousChar	Sets a char previous to the current cursor position.
IRegionWithEditableText.TryGetPreviousChar	Gets a char previous to the current cursor position.
IRegionWithTooltip.TryGetTooltip	Draws a ToolTip image of the Region.