ScriptingOptions Class

In This Topic

Represents the various options controlling scripts and expressions used in a C1.C1Preview.C1PrintDocument, and specified by the C1.C1Preview.C1PrintDocument.ScriptingOptions property.

Object Model

Syntax

Visual Basic
C#

'Declaration
 
Public Class ScriptingOptions

public class ScriptingOptions

Remarks

Scripts and expressions can be used in various contexts in a C1.C1Preview.C1PrintDocument. While the scripting language and the set of available assemblies and namespaces for all those scripts and expressions are defined by the properties of the document's C1.C1Preview.C1PrintDocument.ScriptingOptions, the sets of built-in variable identifiers available to a script or expression depend on the context in which it is defined.

The following tables list the possible contexts, and the identifiers that can be used in scripts and expressions to access context-dependent document data:

In expressions specified in square brackets in texts of C1.C1Preview.RenderText, C1.C1Preview.RenderParagraph or RenderField objects, the following context-dependent identifiers can be used:

Id (type)	Meaning
Document (C1.C1Preview.C1PrintDocument)	The current document.
RenderObject (C1.C1Preview.RenderObject)	The current render object.
RenderFragment (C1.C1Preview.RenderFragment)	The current render fragment.
Page (C1.C1Preview.C1Page)	The current page.
PageNo (System.Int32)	The current 1-based page number.
PageCount (System.Int32)	The total page count.
PageX (System.Int32)	The current 1-based horizontal page number.
PageXCount (System.Int32)	The maximum horizontal page count.
PageY (System.Int32)	The current 1-based vertical (regular) page number.
PageYCount (System.Int32)	The total vertical page count.
Aggregates (C1.C1Preview.DataBinding.AggregateCollection)	The list of aggregates defined on the current document.
DataBinding (C1.C1Preview.DataBinding.C1DataBinding)	The active databinding (may differ from the value of the C1.C1Preview.RenderObject.DataBinding property on the current render object, e.g. if it is not defined and parent's databinding is being used).
Fields (C1.C1Preview.DataBinding.FieldCollection)	A shortcut to Fields on the active databinding.
RowNumber (System.Int32)	A shortcut to C1.C1Preview.DataBinding.C1DataBinding.RowNumber on the active databinding.

(Note: while square brackets are the default for marking expressions in C1PrintDocument texts, they can be redefined via the C1.C1Preview.C1PrintDocument.TagOpenParen and C1.C1Preview.C1PrintDocument.TagCloseParen properties.).

In expressions used in any of Expressions, Expressions, C1.C1Preview.DataBinding.C1DataBinding.Filters, C1.C1Preview.DataBinding.C1DataBinding.OutlineText, the following context-dependent identifiers are available:

Id (type)	Meaning
Document (C1.C1Preview.C1PrintDocument)	The current document.
DataBinding (C1.C1Preview.DataBinding.C1DataBinding)	The current databinding.
Fields (C1.C1Preview.DataBinding.FieldCollection)	The Fields collection of the current databinding.
Parent (C1.C1Preview.DataBinding.C1DataBinding)	The parent databinding. Normally this is the most nested databinding defined on a parent of the object containing the current databinding. For a C1.C1Preview.TableVectorGroup, this may be the databinding defined on another row/column group if that group encloses the current group (i.e. contains all its rows/columns).

In expressions used to specify calculated data set fields (Expression), the following context-dependent identifiers are available:

Id (type)	Meaning
Document (C1.C1Preview.C1PrintDocument)	The current document.
Fields (C1.C1Preview.DataBinding.DataSetFieldCollection)	The C1.C1Preview.DataBinding.DataSet.Fields collection of the current data set.

In scripts assigned to C1.C1Preview.C1PrintDocument.DocumentStartingScript, C1.C1Preview.C1PrintDocument.DocumentEndedScript, C1.C1Preview.C1PrintDocument.PageConfigureScript or C1.C1Preview.C1PrintDocument.ErrorScript, the following context-dependent identifiers are available:

Id (type)	Meaning
Document (C1.C1Preview.C1PrintDocument)	The current document.
Tags (C1.C1Preview.TagCollection)	The C1.C1Preview.C1PrintDocument.Tags collection of the current document (this is a shortcut to Document.Tags).

In scripts assigned to C1.C1Preview.RenderObject.ObjectResolvedScript, the following context-dependent identifiers are available:

Id (type)	Meaning
Document (C1.C1Preview.C1PrintDocument)	The current document.
RenderObject (C1.C1Preview.RenderObject)	The current render object.
Tags (C1.C1Preview.TagCollection)	The C1.C1Preview.C1PrintDocument.Tags collection of the current document (this is a shortcut to Document.Tags).

In scripts assigned to C1.C1Preview.RenderObject.FragmentResolvedScript, the following context-dependent identifiers are available:

Id (type)	Meaning
Document (C1.C1Preview.C1PrintDocument)	The current document.
RenderObject (C1.C1Preview.RenderObject)	The current render object.
RenderFragment (C1.C1Preview.RenderFragment)	The fragment that has resolved.
Tags (C1.C1Preview.TagCollection)	The C1.C1Preview.C1PrintDocument.Tags collection of the current document (this is a shortcut to Document.Tags).

Inheritance Hierarchy

System.Object
C1.C1Preview.Scripting.ScriptingOptions

Reference

ScriptingOptions Members
C1.C1Preview.Scripting Namespace