SMath Studio Core documentation
File
File managing context.
Definition
Namespace: SMath.Controls
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.74.9654.0
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.74.9654.0
C#
public class FileContext : ActionContext,
IDocumentLoaderProviderVB
Public Class FileContext
Inherits ActionContext
Implements IDocumentLoaderProviderC++
public ref class FileContext : public ActionContext,
IDocumentLoaderProviderF#
type FileContext =
class
inherit ActionContext
interface IDocumentLoaderProvider
end- Inheritance
- Object DocumentParams ActionContext FileContext
- Implements
- IDocumentLoaderProvider
Constructors
| FileContext(FileContext, String) | File context Class constructor. |
| FileContext(SessionProfile, String) | File context Class constructor. |
Properties
| AbsoluteDefinitions | Gets or sets a list of Absolute Definitions (definitions available to read/write anywhere in the Worksheet) for the Worksheet. |
| Action |
Text value of the current context usage.
(Inherited from ActionContext) |
| Async | Determines if operations with files should be asynchronous or not. |
| BackFile | Back file for current worksheet to work in Reference Book mode. |
| Cancel |
Determines if operation requests for canceling.
(Inherited from ActionContext) |
| Dependencies |
Provides access to items RegionDependencies for backward compatibility.
(Inherited from ActionContext) Obsolete. |
| DocumentLoader | Provides access to the loader of the documents. |
| Extension | File extension (in lower case). |
| FileName |
Current Document full file name.
(Inherited from DocumentParams) |
| FractionsTypeNumeric |
Numeric fractions type required for current context.
(Inherited from ActionContext) |
| GeneratorVersion |
Version of the application.
(Inherited from ActionContext) |
| HomeFile | Home file for current worksheet to work in Reference Book mode. |
| Id |
Id of the Document.
(Inherited from DocumentParams) |
| IgnoreImages | When the value is embedded images are not handled. |
| LockedSource | Determines if peration should not affect on the source Worksheet. |
| MetaData | Worksheet meta-data. |
| Mode | Presentation mode of the document. |
| PageModel | Print out worksheet parameters. |
| PagesOptions | Worksheets' options. |
| ReadOnlySource | Determines if source file is read-only, so the user should not be able to save changes back to it. |
| RegionDependencies |
Dependencies of regions on plug-ins which are collected by the context.
(Inherited from ActionContext) |
| RegionsBounds | Overall bounds for the Regions in process. |
| RequestType | Type of the files related operation. |
| Revision |
Revision number of the Document.
(Inherited from DocumentParams) |
| SaveFileName | Full path to the file saving should be performed to (can be temporary one). |
| SaveInTempFile | Determines if file should be saved in temporary file first. |
| SessionProfile |
Session parameters.
(Inherited from ActionContext) |
| Shortcut | Shortcut for the snippet file for convenient way to insert it to the Worksheet. |
| SuppressUI |
Determines whether any interactions with user is not supported.
(Inherited from ActionContext) |
| WorksheetSize | Current worksheet canvas Size. |
| WorksheetStatus | Current document status. |
Methods
| AddDependency |
Adds dependency from the specifed plug-in.
(Inherited from ActionContext) Obsolete. |
| 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) |
| GenerateMetaContext | Returns meta context for current IO operation. |
| GenerateMetaContext(SessionProfile, DocumentParams, DictionaryString, WorksheetInfo) | Returns meta context for IO operation by the given data. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| RaiseError |
Raise an error message.
(Inherited from ActionContext) |
| RequestPlugins |
Raise a message about plg-in is requested.
(Inherited from ActionContext) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Trace | Sends trace data to the subscribers. |
| UpdateFileName | Updates a file name in current File managing context. . |
| UpdateStatus | Updates IO operation status. |
Events
| ErrorOccured |
Occurs if an error is found while the operation is in progress.
(Inherited from ActionContext) |
| OnActionCompleted | Occurs on completion of input/output operation. |
| OnDataTrace | Occurs on data sent to trace. |
| PluginsRequested |
Occurs if any plug-ins are requested.
(Inherited from ActionContext) |