Page Class

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "T:Monkeyspeak.Page"]

Inheritance Hierarchy

SystemObject
MonkeyspeakPage

Namespace: Monkeyspeak
Assembly: Monkeyspeak (in Monkeyspeak.dll) Version: 7.0.10.28723 (7.0.10.28723)

Syntax

C++

Copy

[SerializableAttribute]
public sealed class Page : IDisposable

<SerializableAttribute>
Public NotInheritable Class Page
	Implements IDisposable

[SerializableAttribute]
public ref class Page sealed : IDisposable

[<SealedAttribute>]
[<SerializableAttribute>]
type Page =  
    class
        interface IDisposable
    end

The Page type exposes the following members.

Constructors

	Name	Description
	Page	Initializes a new instance of the Page class

Top

Properties

	Name	Description
	Debug	Gets or sets a value indicating whether this Page is in debug mode.
	Engine
	Libraries	Gets the libraries.
	Scope	All variables loaded into this page
	Size	Returns the Trigger count on this Page.

Top

Methods

	Name	Description
	AddBlocks
	CheckType
	Clear	Removes the triggers.
	CompileToFile
	CompileToStream
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	Execute(Int32, Object)	Executes a trigger block containing TriggerCategory.Cause with ID equal to id
	Execute(Int32, Object)	Executes a trigger block containing TriggerCategory.Cause with ID equal to
	Execute(TriggerCategory, Int32, Object)	Executes a trigger block containing cat with ID equal to id
	ExecuteAsync(Int32, Object)	Executes the specified Cause asynchronously.
	ExecuteAsync(CancellationToken, Int32, Object)	Executes the asynchronous.
	ExecuteAsync(TriggerCategory, Int32, Object)	Executes the specified Cause asynchronously.
	ExecuteAsync(TriggerCategory, Int32, Object)	Executes the specified Cause asynchronously.
	ExecuteAsync(CancellationToken, TriggerCategory, Int32, Object)	Executes the asynchronous.
	ExecuteAsync(CancellationToken, TriggerCategory, Int32, Object)	Executes the asynchronous.
	ExecuteBlock
	ExecuteTrigger
	GenerateBlocks
	GetLibraryT
	GetTriggerDescription	Gets the description for a trigger
	GetTriggerDescriptions	Gets the description for all triggers
	GetVariable	Gets a Variable with Name set to nameThrows Exception if Variable not found.
	HasVariable(String)	Checks the scope for the Variable with Name set to name
	HasVariableT(String, T)	Determines whether the specified variable exists.
	Initiate
	LoadAllLibraries	Loads all libraries.
	LoadCompiledStream
	LoadDebugLibrary	Loads Monkeyspeak Debug Library into this Page Used for Debug breakpoint insertion. Won't work without Debugger attached.
	LoadIOLibrary	Loads Monkeyspeak IO Library into this Page Used for File Input/Output operations
	LoadLibrary	Loads a BaseLibrary into this Page
	LoadLibraryFromAssembly(Assembly)	Loads trigger handlers from a assembly instance
	LoadLibraryFromAssembly(String)	Loads trigger handlers from a assembly dll file
	LoadMathLibrary	Loads Monkeyspeak Math Library into this Page Used for Math operations (add, subtract, multiply, divide)
	LoadStringLibrary	Loads Monkeyspeak String Library into this Page Used for basic String operations
	LoadSysLibrary	Loads Monkeyspeak Sys Library into this Page Used for System operations involving the Environment or Operating System
	LoadTimerLibrary	Loads Monkeyspeak Timer Library into this Page
	RemoveAllTriggerHandlers	Removes all trigger handlers.
	RemoveLibraryT
	RemoveTriggerHandler(Trigger)	Removes the trigger handler.
	RemoveTriggerHandler(TriggerCategory, Int32)	Removes the trigger handler.
	RemoveVariable(String)	Removes the variable.
	RemoveVariable(IVariable)	Removes the variable.
	Reset	Clears all Variables and optionally clears all TriggerHandlers from this Page.
	SetTriggerHandler(Trigger, TriggerHandler, String)	Assigns the TriggerHandler to trigger
	SetTriggerHandler(TriggerCategory, Int32, TriggerHandler, String)	Assigns the TriggerHandler to a trigger with category and id
	SetVariable(String, Object, Boolean)	Sets the variable.
	SetVariableT(T)	Sets the variable.
	SetVariableTable	Sets the variable table.
	TrimToLimit

Top

Events

	Name	Description
	AfterTriggerHandled	Called after the Trigger's TriggerHandler is called. If there is no TriggerHandler for that Trigger then this event is not raised.
	BeforeTriggerHandled	Called before the Trigger's TriggerHandler is called. If there is no TriggerHandler for that Trigger then this event is not raised.
	Error	Called when an Exception is raised during execution
	Initiating	Occurs when [initiating]. Best to call your variable additions in the event.
	Resetting
	TriggerAdded	Called when a Trigger and TriggerHandler is added to the Page

Top

Fields

	Name	Description
	handlers
	scope
	syncObj
	VisitingToken

Top

Extension Methods

	Name	Description
	AsT	(Defined by ObjectExtensions.)

Top

Reference

Monkeyspeak Namespace