RegionEvaluable Class

Base class for every worksheet Region that supports evaluation.

Definition

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

C#
public abstract class RegionEvaluable : RegionBase, 
	IEvaluableObject, IDocumentObject, IEvaluable, IRegionEvaluableInternal, IRegionInternal

VB
Public MustInherit Class RegionEvaluable
	Inherits RegionBase
	Implements IEvaluableObject, IDocumentObject, IEvaluable, IRegionEvaluableInternal, 
	IRegionInternal

C++
public ref class RegionEvaluable abstract : public RegionBase, 
	IEvaluableObject, IDocumentObject, IEvaluable, IRegionEvaluableInternal, IRegionInternal

F#
[<AbstractClassAttribute>]
type RegionEvaluable = 
    class
        inherit RegionBase
        interface IEvaluableObject
        interface IDocumentObject
        interface IEvaluable
        interface IRegionEvaluableInternal
        interface IRegionInternal
    end

Inheritance: Object RegionBase RegionEvaluable

Derived: SMath.Controls.MissingRegion
SMath.Controls.RegionHolder<T>

Implements: IDocumentObject, IEvaluable, IEvaluableObject, IRegionEvaluableInternal, IRegionInternal

Constructors

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

Properties

ActiveDebugTermIndex	Determines an index of the Term which is shown as an active expression entry in the debugging session.
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. (Overrides RegionBase.BaseSize)
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. (Overrides RegionBase.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.
DebugTerms	Determines dictionary of the Term and their relative locations which are set as breakpoints.
DeletedValues	List of IPrimitive entries remmoved from the evaluation context during calculation process in the scope of current region.
Dependences	List of assemblies the region depends on. (Inherited from RegionBase)
DescriptionBounds	Determines the bounding rectange of Description according to ShowDescription and DescriptionLocation. If ShowDescription is false then returns an empty rectangle.
DescriptionLocation	Specifies the location of Description.
DescriptionText	Returns the value of ToString() for Description. If Description is null then returns Empty.
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.
ErrorTerm	Index of term where evaluation error is found.
ErrorText	Error text of the element.
Evaluable	Gets or sets value defines if the Region is valuable or not.
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 RegionBase.Focused)
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)
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.
InEvaluation	Gets or sets whether Region is under evaluation now.
InnerBounds	Bounds of the content Region area relative to the Worksheet. (Overrides RegionBase.InnerBounds)
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. (Overrides RegionBase.MiddleLine)
Optimization	Optimization type for evaluation of the region.
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)
SelectedTermsIndexes	Indexes of the inner content to determine currently selected content part.
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.
Size	The size of the control. (Overrides RegionBase.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.
TextColor	The text color of the element. (Inherited from RegionBase)
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.
WarningColor	The color of the element's warnings.

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.
CheckForMissingParenthesis	Checks for missing parenthesis in math expression and tries to fix found cases.
ChildRepainting	Invalidates container region. (Overrides RegionBase.ChildRepainting(RegionBase, Rectangle))
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 RegionBase.Copy(IClipboardManager))
CreateDescription	Creates Description unless it is already present.
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. (Inherited from RegionBase)
GetBestDimension(SessionProfile, Term[], String)	Looks up for the best output dimension ID and unit of measurement for the given calculation result.
GetBestDimension(MItem, List<MItem>, Boolean, String, MItem, String)	Looks up for the best output dimension ID and unit of measurement for the given calculation result.
GetcurrentTermsContainer	Returns region container for the region. Provides a reference to the container region of the current child region, points to region itself otherwise. 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.
GetCursorType	Defines a cursor type by pointer location. (Overrides RegionBase.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 RegionBase.GetHistoryStep())
GetSelectionStatus	Determines the selection status of the region contents. (Inherited from RegionBase)
GetType	Gets the Type of the current instance. (Inherited from Object)
InitLayout()	Initializes layout of the region. (Overrides RegionBase.InitLayout())
InitLayout(Store)	Initializes layout of the region with regards to a given store.
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)
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 RegionBase.OnCommandSend(String))
OnCommandSend(Term[])	Handles input given by value.
OnEvaluation	Performs evaluation of the region.
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 RegionBase.OnMouseDown(MouseEventOptions))
OnMouseMove	Handles MouseMove event. (Overrides RegionBase.OnMouseMove(MouseEventOptions))
OnMouseUp	Handles MouseUp event. (Overrides RegionBase.OnMouseUp(MouseEventOptions))
OnMouseWheel	Handles MouseWheel event. (Inherited from RegionBase)
OnPaint	Handles Paint event. (Overrides RegionBase.OnPaint(PaintEventOptions))
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. (Overrides RegionBase.Paste(IClipboardManager))
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)
ReadMath	Reads the mathematical expression from XML on load of the document.
ReadXmlProperties	Reads additional properties of the region from XML on load of the document.
ReadyToPaint	Does nothing. (Inherited from RegionBase) Obsolete.
RequestEntryInfo	Requests displaying information about currently selected math expression element.
RequestEvaluation	Requests Worksheet to perform evaluation starting from the current Region.
RequestForEvaluation	Invokes RequestEvaluation(Boolean) with immediate argument equal to true. 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.
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.
ShowError(Exception, Term)	Reports an error in an element during evaluation.
ToString	Returns a string that represents the current object. (Inherited from Object)
ToXml	Writes the region to XML on save of the document. (Inherited from RegionBase)
WriteMath	Writes the mathematical expression to XML on save of the document.
WriteXmlProperties	Writes additional properties of the region to XML on save of the document.

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.
EvaluationRequest	Occurs when start of evaluation from this region is requested.
EvaluationStateChanged	Occurs when the evaluation state of the region is changed.
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.
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.
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.

Explicit Interface Implementations

IRegionEvaluableInternal.InitEvaluableLayout

Calls InitLayout(Store) once per lifetime of the evaluable region.