C1.C1Report.2
Represents an anchor within a document.
One or more anchors can be associated with a
via the property on the object.
An anchor (and thus the render object associated with it) can be the
target of a if that hyperlink's
is a and that anchor's
is set to that anchor's .
Initializes a new instance of the class.
Initializes a new instance of the class.
The anchor's name.
Initializes a new instance of the class.
The anchor's name.
The anchor's description.
Initializes a new instance of the class.
The anchor's name.
The anchor's description.
Arbitrary user data.
Gets the name of the current anchor (must be unique within the document).
Gets the description of the current anchor.
Gets the custom user data associated with the current anchor.
Represents an anchor within a text object
(a , a or a ).
Based on , adds the ability to reference a specific position within the text
(see ).
Initializes a new instance of the class.
Initializes a new instance of the class.
The anchor's name.
Initializes a new instance of the class.
The anchor's name.
The anchor's description.
Initializes a new instance of the class.
The anchor's name.
The anchor's description.
Arbitrary user data.
Initializes a new instance of the class.
The anchor's name.
The position within the text.
Initializes a new instance of the class.
The anchor's name.
The anchor's description.
The position within the text.
Initializes a new instance of the class.
The anchor's name.
The anchor's description.
Arbitrary user data.
The position within the text.
Gets the position of anchor withint text, zero based.
Represents a collection of objects.
Adds a to the current collection.
The anchor to add.
Index of the newly added anchor in the current collection.
Inserts a into the current collection.
The position at which to insert the anchor.
The anchor to insert.
Removes a from the current collection.
The anchor to remove.
Returns the index of a in the current collection.
The anchor to search for.
The index of the specified anchor in the current collection, or -1.
Searches for an anchor with the specified name in the current collection.
The name to search for.
The anchor with the specified name, or null if the anchor was not found.
Gets or sets the at the specified index.
For internal use.
For internal use.
For internal use.
The abstract base class for type converters that can convert to/from strings.
Converts a string to an object.
An that provides a format context.
The string to convert.
The converted object.
Converts an object to a string.
An that provides a format context.
The object to convert.
The converted string.
Represents the state of a .
An unvisited hyperlink.
A hyperlink that has been visited.
A hyperlink under the mouse pointer.
A hyperlink that has been clicked, but not yet visited.
Represents a hyperlink in a document.
A hyperlink may be assigned to a 's ,
or a 's property.
In that case clicking on that object in a viewer will jump to the hyperlink's .
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning its to a
associated with the specified .
The to set as the target of the current hyperlink.
Initializes a new instance of the class,
assigning its to a
associated with the specified .
The to set as the target of the current hyperlink.
Initializes a new instance of the class,
assigning its to the specified .
The to set as the target of the current hyperlink.
Initializes a new instance of the class,
assigning its to the specified .
The to set as the target of the current hyperlink.
The string to assign to of the current hyperlink.
Initializes a new instance of the class,
assigning its to the specified .
The to set as the target of the current hyperlink.
The string to assign to of the current hyperlink.
Arbitrary value to assign to of the current hyperlink.
Initializes a new instance of the class,
assigning its to a
associated with the specified anchor name.
The name of the to set as the target of the current hyperlink.
Copies the properties of the specified object to the current object.
The source object to copy properties from.
Creates a copy of the current object.
The newly created object.
Text shown in the status line when the mouse is over the link
(when the document is viewed in a C1PrintPreview).
Determines the target of the current hyperlink.
The hyperlink target is described by an instance of a class derived from ,
and can be of one of the following types:
-
An anchor defined within the current document.
-
A location within the current document.
-
An anchor defined within a previously saved C1D document.
-
An external document, program or URL. The ShellExecute API is used to invoke the link.
-
A page within the current document.
-
The hyperlink target is determined by a user event handler.
Gets or sets arbitrary data associated with the current hyperlink.
Gets or sets the state of the current hyperlink.
Gets the destination URL of the current hyperlink in Adobe PDF format.
Describes the target of a .
This is an abstract base class for the following derived classes:
,
,
,
,
,
.
Initializes a new instance of the class.
Gets the 1-based number of the page pointed to by the current .
This method may return 0 if the page cannot be resolved at this time
(e.g. the document has not generated yet).
The page containing the current object.
null may be specified if the is associated with an .
The containing the current .
The target page number.
Returns the pointed to by the current link target.
This method may return null if the position cannot be resolved at this time
(e.g. if the document has not generated yet) or the link target points
to a position outside the document (e.g a URL or an external document).
0-based index of the page containing the current link target.
This is used for relative targets (such as previous page) and may be -1 if there is no current
page in the current context, or the link target is absolute.
The document containing the current link target.
The containing the target location.
Returns the pointed to by the current link target.
This method may return null if the position cannot be resolved at this time
(e.g. if the document has not generated yet) or the link target points
to a position outside the document (e.g a URL or an external document).
0-based index of the page containing the current link target.
This is used for relative targets (such as previous page) and may be -1 if there is no current
page in the current context, or the link target is absolute.
The document containing the current link target.
The containing the target location.
Gets the target URL, or an empty string if it does not exist.
Gets the target URL in Adobe PDF format, or an empty string if it does not exist.
Describes a determined by a user event handler.
When using C1.Win.C1Preview.C1PreviewPane, attach a handler of the type
C1.Win.C1Preview.HyperlinkEventHandler to the C1PreviewPane's UserHyperlinkJump
event. That event will be fired when a hyperlink with the link target
of this type is clicked.
Initializes a new instance of the class.
Describes a pointing to a
within the current document.
Initializes a new instance of the class.
Initializes a new instance of the class.
The name () of the target .
Gets the name () of the target object.
Gets the target URL, or an empty string if it does not exist.
Gets the target URL in Adobe PDF format, or an empty string if it does not exist.
Describes a pointing to a
in a different object.
Initializes a new instance of the class.
Initializes a new instance of the class.
The name of the file (C1D or C1DX) containing the target document.
The name () of the target .
Gets the filename with the target object.
Gets the target URL, or an empty string if it does not exist.
Gets the target URL in Adobe PDF format, or an empty string if it does not exist.
Describes a pointing to an external document, file or URL.
The hyperlink jump is performed using the ShellExecute OS shell API, so the result
depends on the operating system and installed programs.
Initializes a new instance of the class.
Initializes a new instance of the class.
The name of the file to execute on hyperlink jump (can be a document, URL etc.).
Initializes a new instance of the class.
The name of the file to execute on hyperlink jump (can be a document, URL etc.).
The shell command to execute (see for details).
Initializes a new instance of the class.
The name of the file to execute on hyperlink jump (can be a document, URL etc.).
The shell command to execute (see for details).
The command parameters.
The directory where the command is executed.
Specifies the file or object on which to execute the specified verb.
To specify a Shell namespace object, pass the fully qualified parse name.
Note that not all verbs are supported on all objects.
For example, not all document types support the "print" verb.
Gets the command (verb) specifying the action to perform when the link is clicked.
The set of available verbs depends on the particular file or folder.
Generally, the actions available from an object's shortcut menu are
available verbs.
For more information about verbs and their availability, see Object Verbs.
See Extending Shortcut Menus for further discussion of shortcut menus.
The following verbs are commonly used.
-
edit
Launches an editor and opens the document for editing. If FileName is not a document file, the function will fail.
-
explore
Explores the folder specified by FileName.
-
find
Initiates a search starting from the specified directory.
-
open
Opens the file specified by the FileName parameter.
The file can be an executable file, a document file, or a folder.
-
print
Prints the document file specified by FileName.
If FileName is not a document file, the function will fail.
-
Empty string
For systems prior to Microsoft? Windows? 2000, the default verb is used
if it is valid and available in the registry. If not, the "open" verb is used.
For Windows 2000 and later systems, the default verb is used if available.
If not, the "open" verb is used. If neither verb is available,
the system uses the first verb listed in the registry.
If the parameter specifies an executable file, this is a string
specifying the parameters to be passed to the application.
The format of this string is determined by the verb that is to be invoked.
If specifies a document file, this should be an empty string.
Gets the default directory.
Gets the target URL, or an empty string if it does not exist.
Gets the target URL in Adobe PDF format, or an empty string if it does not exist.
Describes the supported modes of moving between pages in a viewer.
Move to the first page.
Move to the previous page.
Move to the next page.
Move to the last page.
Move directly to the specified page.
Move to the page specified relative to the current page.
Describes a pointing to another page in the current document.
Initializes a new instance of the class.
Initializes a new instance of the class.
The absolute 1-based target page number.
Initializes a new instance of the class.
The type of the page jump.
Initializes a new instance of the class.
The type of the page jump.
The absolute 1-based target page number.
Gets the type of page jump.
Gets the page number to jump to.
Depending on the value of , specifies
an absolute (1-based) or a relative page number.
Describes a pointing to an object within the current document
that supports the interface.
Types supporting that interface include ,
, , and table elements (rows, columns, etc.).
Initializes a new instance of the class.
Initializes a new instance of the class.
The target object (must support the interface).
Gets the target object supporting the interface.
Represents the page settings of a .
Initializes a new instance of the class.
Initializes a new instance of the class
from another object.
The object to initialize the current one from.
Initializes a new instance of the class
from another object.
The object to initialize the current one from.
A value indicating whether the current page settings should have landscape orientation.
Initializes a new instance of the class
from a object.
The object to initialize the current page settings from.
Sets the and the to specified values.
The width to set.
The height to set.
Compares the current with another object.
The object to compare the current one to.
True if the two objects contain identical properties, false otherwise.
Creates a copy of the current object.
The newly created object.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Assigns (copies) properties from a to the current object.
The source object to copy properties from.
Creates an instance of the class,
and initializes it with the properties of the current object.
The object providing the default units
(needed if some sizes in the current object are specified in ) and DPI
(needed if some sizes in the current object are specified in ).
Can be null, but in that case the current object must not contain sizes
specified in document default units or pixels.
A object
used to create the resulting .
If null, the default printer is used.
The newly created object.
Creates an instance of the class,
and initializes it with the properties of the current object.
The object providing the default units
(needed if some sizes in the current object are specified in ) and DPI
(needed if some sizes in the current object are specified in ).
Can be null, but in that case the current object must not contain sizes
specified in document default units or pixels.
The newly created object.
Creates an instance of the class,
and initializes it with the properties of the current object.
The newly created object.
Compares the properties of two objects.
The first object to compare.
The second object to compare.
True if the two objects' properties are identical, false otherwise.
Retrieves the locale-specific default paper size for the current locale.
OUT: The width of the default paper.
OUT: The height of the default paper.
OUT: The width of default margins.
OUT: Unit of measurement used to express the sizes (width, height and margin).
Creates a new instance of the class.
If is true,
initializes the newly created object with settings based on the current
printer (specified by ).
Otherwise, initializes the newly created object with default system locale settings.
The newly created object.
Gets the object containing current object.
Gets or sets a value indicating whether to use the printer paper size
when generating the document.
This property does not affect the values of
,
,
and
properties.
Gets the object containing the current .
Null is returned if the current object does not belong to a .
Gets or sets a value indicating whether to use landscape orientation.
Changing this property swaps height and width of the page.
Gets or sets the width of the paper.
Gets or sets the height of the paper.
Gets or sets the paper kind.
Changing of this property may change and/or .
Gets or sets a value indicating whether the document should be printed in color.
Gets or sets the left margin.
Gets or sets the top margin.
Gets or sets the right margin.
Gets or sets the bottom margin.
Gets or sets the desired paper source kind.
Gets or sets the name of the paper source.
Gets or sets the integer representing one of the PaperSourceKind values or a custom value.
Gets or sets the desired printer resolution kind.
Gets or sets the horizontal printer resolution, in dots per inch,
used when is Custom.
Gets or sets the vertical printer resolution, in dots per inch,
used when is Custom.
Provides for the class.
Tests whether an object of the specified type can be converted to the type of this converter.
An that provides a format context.
A that represents the type to convert from.
True if this converter can perform the conversion, false otherwise.
Converts the given value object to the specified type.
An that provides a format context.
A . If a null reference (Nothing in Visual Basic) is passed, the current culture is assumed.
The object to convert.
The to convert the value parameter to.
An Object that represents the converted value.
Specifies the look and feel of input controls displayed by render objects
derived from .
The property returns a member of this enumeration.
Specifies the Adobe Acrobat Forms style.
Specifies the Microsoft InfoPath style.
Specifies the Windows XP (system) style.
Specifies the Windows classic style.
Specifies the persistence format.
Specifies the original C1Preview for .NET 2.0 format
(a document is represented by a single XML file).
Specifies the Open Packaging Conventions compliant format
(a document is represented by a structured zip file).
Specifies the binary serialization format
(a document is represented by a sequence of bytes).
Specifies how font embedding and substitution are handled by a
(see for details).
Fonts are not embedded, and font substitution is not analyzed.
Collections and
are not populated when the document is generated.
Fonts are not embedded, and font substitution is not analyzed,
but the collection
is populated with fonts explicitly used in the document
when it is generated.
The collection
is not populated.
Fonts are not embedded, but font substitution is analyzed.
The collection
is populated with fonts actually used in the document
when it is generated.
The collection
is not populated.
Fonts are embedded, but font substitution is not analyzed.
Collections and
are populated with fonts explicitly used in the document
when it is generated.
Fonts are embedded, and font substitution is analyzed.
Collections and
are populated with fonts actually used in the document
when it is generated.
Represents a ComponentOne Document.
Represents a document that can be previewed, printed or exported to an external format.
Defines a class that can expose a Style property (of the type ).
Retrieves the value of an ambient property.
The property key.
to use for evaluation of calculated properties.
The property value.
Retrieves the value of a non-ambient property.
The property key.
to use for evaluation of calculated properties.
The property value.
Gets the value of a style property existing on the current object
(does not attempt to resolve properties not explicitly defined on the current object).
The property key (any of the Style.c_propXXX constants).
that should be used to get calculated properties.
The property value.
Gets the parent for ambient properties.
Gets the style of the current .
Gets the dictionary object used to store images.
Gets the list of embedded fonts.
This collection is used to deserialize the fonts.
For internal use only.
Describes an interface allowing an object that implements it to receive
notifications about changes from .
Called when the owned collection is being cleared.
The that is being cleared.
Called after the owned collection has been cleared.
The that has been cleared.
Called when an item is about to be inserted into the owned collection.
The into which the item is about to be inserted.
The index of the item that is being inserted.
The item that is being inserted.
Called after an item has been inserted into the owned collection.
The into which the item has been inserted.
The index of the item that has been inserted.
The item that has been inserted.
Called when an item is about to be removed from the owned collection.
The from which the item is about to be removed.
The index of the item that is being removed.
The item that is being removed.
Called after an item has been removed from the owned collection.
The from which the item has been removed.
The index of the item that has been removed.
The item that has been removed.
Called when an item is about to be set in the owned collection.
The in which the item is about to be set.
The index of the item that is being set.
The old value of the item that is being set.
The new value for the item that is being set.
Called after an item has been set in the owned collection.
The in which the item has been set.
The index of the item that has been set.
The old value of the item that has been set.
The new value for the item that has been set.
Describes a location within a
(used e.g. as the target of a hyperlink etc.).
The location is identified by a page and a rectangle on that page.
The rectangle's unit of measurement is determined by the document's
property.
Classes that implement this interface are
, and .
Gets the index of page (zero-based) containing this location.
Gets the logical number of page containing this location.
Gets the enclosing this location.
Gets the used by the property.
Gets the resolution (DPI) used by the property
(relevant only if the units used are ).
For internal use.
This interface is used to allow objects to receive notifications from Serializer.
Describes a scripting context.
Gets the current C1DataBinding object, can return null it means that
the databinding is not defined.
Gets the C1PrintDocument object containing this context.
Gets the current Page object, can be null in this case
the page depended expression can't be calculated.
Gets the current hyperlink.
Gets the hyperlink's link target, it can differ from Hyperlink.LinkTarget
if link target has calculated properties.
Provides uniform access to the a document's pages.
For internal use only.
Gets a page image.
For internal use only.
Zero-based page index.
Indicates whether the RenderInput objects should be rendered.
The metafile representing the page.
Gets the logical page number associated with a page.
For internal use only.
Zero-based page index.
The logical page number.
Gets a object defining position of anchor in document.
Anchor's name
object or null if anchor not found.
Gets a object defining page in document.
Zero-base page index
object or null if page index is not valid.
Gets the total number of pages in the document.
For internal use only.
Initializes a new instance of the class.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Called when the property value has changed.
Called when the property value has changed.
Called when the property value has changed.
Called to indicate the progress of document generating.
How much is complete (from 0 to 1).
Whether the generating can be cancelled.
Returns true if generation is *not* aborted.
Performs some initializations: creates the sub-objects (PageHeader, PageFooter etc)
initializes DefaultPageSettings and so on.
Clears the current document, sets all properties to their default values.
Saves the current document to a disk file. The persistense format
( or )
is determined by the specified file extension. The save format defaults
to if the format cannot be determined from the extension.
The target file name.
Saves the current document to a disk file using the specified format.
The target file name.
The document persistence format to use.
Saves the current document to a stream using the format.
The target stream.
Saves the current document to a stream using the specified format.
The target stream.
The document persistence format to use.
Loads the current document from a stream.
The stream should contain a document in format.
The stream from which to load the document.
Loads the current document from a stream.
The stream from which to load the document.
The document persistence format to use.
Loads the current document from a file.
The persistence format ( or )
is determined by the file extension.
The format defaults to
if the format cannot be determined from the extension.
The source file name.
Loads the current document from a file.
The source file name.
The document persistence format to use.
Creates a new instance of the class,
and loads the document from the specified file.
The name of the file from which to load the document.
The document persistence format to use.
The that was created.
Creates a new instance of the class,
and loads the document from the specified file.
The persistence format ( or )
is determinated by the file extension.
If the format cannot be determined by the extension, the format is used.
The name of the file from which to load the document.
The that was created.
Creates a new instance of class,
and loads the document from the specified stream.
The stream from which to load the document.
The document persistence format to use.
The that was created.
Creates a new instance of the class,
and loads the document from the specified stream.
The stream must contain a document in the format.
The stream from which to load the document.
The that was created.
Selects a device to use for .
This method looks for a printer with a "square" resolution
(i.e. with the same horizontal and vertical DPI) equal to or larger than 300 DPI.
If such a printer is found, it is assigned to ,
and is set to .
Otherwise, is set to .
The selected device's resolution is returned by .
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Releases the resoureces used by .
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Called when the property
of a object contained in the current document has changed.
Raises the event.
The object on which the input value has changed.
Raises the event.
Raises the event.
Called when a new empty page is created and added to the current document,
raises the event.
When this method is called, the has already been added to the collection
but has not yet been resolved.
If overridden in a derived class, must call the base method; can be used to change the layout of the new page.
The newly added object.
The object created by the event, or null.
Called during document generation after a has completely generated,
raises the event.
The object identifying the generated page.
Called during document generation after a has updated,
raises the event.
This method is called each time a 's fragment
() is added to or removed from the page
(i.e. this method is called very often while the document generates).
See also .
The object identifying the updated page.
Called during document generation after a
that has already been added to the document has changed
(e.g. if page numbering is changed, or the PageCount tag used on the page is updated),
raises the event.
See also .
The object identifying the changed page.
Called when a page is removed from the collection.
The object identifying the deleted page.
Called when the collection is about to be cleared.
Raises the event.
Called after the collection has been cleared.
Raises the event.
Called when the document is starting to generate.
Raises the event.
The property is set to
after this method returns.
See remarks for more details.
The following order is observed before and after the document generation:
- Raises the event.
- = changed to .
- Executes the script.
-
... document's generation ...
- Executes the script.
- = changed to .
- Raises the event.
Called when the document is starting to generate.
Executes the script.
See remarks in method for details and order of events.
Called when the document has finished generating.
Raises the event.
The property is set to
before this method is called.
See remarks in method for more details.
Called when the document has finished generating.
Executes the script.
See remarks in method for details and order of events.
Clears the pages and other info created during document generation.
This method does not clear the document structure/content though.
Converts a double value expressed in the current document's units
to other units.
The value to convert, expressed in units.
The destination units to convert to.
The destination resolution (DPI), required only if is .
The converted value.
Converts a value expressed in the current document's units
to other units.
The value to convert, expressed in units.
The destination units to convert to.
The horizontal destination resolution (DPI), required only if is .
The vertical destination resolution (DPI), required only if is .
A structure converted to target units.
Transforms (scales) a object expressed in the current document's units
so that it uses other units.
The to scale.
The destination units to use.
The horizontal destination resolution (DPI), required only if is .
The vertical destination resolution (DPI), required only if is .
Converts a value expressed in the current document's units
to other units.
The value to convert, expressed in units.
The destination units to convert to.
The horizontal destination resolution (DPI), required only if is .
The vertical destination resolution (DPI), required only if is .
A structure converted to target units.
Converts a double value expressed in the current document's units
to other units,
using resolution if is .
The value to convert, expressed in units.
The destination units to convert to.
The value converted to units.
Converts a value expressed in the current document's units
to other units,
using resolution if is .
The value to convert, expressed in units.
The destination units to convert to.
A structure converted to target units.
Converts a value expressed in the current document's units
to other units,
using resolution if is .
The value to convert, expressed in units.
The destination units to convert to.
A structure converted to target units.
Converts a value expressed in the current document's units
to other units.
The value to convert, expressed in units.
The destination units to convert to.
The horizontal destination resolution (DPI), required only if is .
The vertical destination resolution (DPI), required only if is .
A structure converted to target units.
Converts a double value expressed in the current document's units
to units with resolution specified by .
Depending on the parameter, the converted value is either simply truncated,
or rounded (slower but more precise).
The value to convert, expressed in units.
The destination resolution (DPI).
true to truncate the converted value, false to round it (slower but more precise).
The converted value.
Converts a value expressed in the current document's units
to a structure expressed in units,
using the specified resolution.
Depending on the parameter, the converted value is either simply truncated,
or rounded (slower but more precise).
The value to convert, expressed in units.
The horizontal destination resolution (DPI).
The vertical destination resolution (DPI).
true to truncate the converted value, false to round it (slower but more precise).
A structure converted to pixels.
Converts a value expressed in the current document's units
to a structure expressed in units,
using the specified resolution.
Depending on the parameter, the converted value is either simply truncated,
or rounded (slower but more precise).
The value to convert, expressed in units.
The horizontal destination resolution (DPI).
The vertical destination resolution (DPI).
true to truncate the converted value, false to round it (slower but more precise).
A structure converted to pixels.
Converts a double value expressed in specified units
to a double value expressed in the current document's units.
The source value to convert.
The unit of measurement used to express the source .
The source resolution (DPI) (used if is ).
The double value expressed in units.
Converts a structure expressed in specified units
to a RectangleD expressed in the current document's units.
The source value to convert.
The unit of measurement used to express the source .
The horizontal source resolution (DPI) (used if is ).
The vertical source resolution (DPI) (used if is ).
The expressed in units.
Converts a double value expressed in specified units
to a double value expressed in the current document's units,
using as the source resolution if is .
The source value to convert.
The unit of measurement used to express the source .
If equal to , the current document's is used as the source resolution (DPI).
The double value expressed in units.
Converts a structure expressed in specified units
to a RectangleD expressed in the current document's units,
using as the source resolution if is .
The source value to convert.
The unit of measurement used to express the source .
If equal to , the current document's is used as the source resolution (DPI).
The expressed in units.
Converts an absolute value to the specified measurement units
(this overload cannot convert to pixels).
The source value to convert (must be an absolute value).
The destination unit type (; cannot be ).
A double representing the value expressed in units.
The must be an absolute value, such as "5mm", "1.5in", "8" and so on.
The source cannot be an expression (such as "prev.width" or "prev.height*2+2mm").
The destination units cannot be .
To convert to pixels, use instead.
Converts an absolute value to the specified measurement units.
The source value to convert (must be an absolute value).
The destination unit type ().
The destination resolution (DPI; used if the is ).
A double representing the value expressed in units.
The must be an absolute value, such as "5mm", "1.5in", "8" and so on.
The source cannot be an expression (such as "prev.width" or "prev.height*2+2mm").
Checks whether the document contains any tags that can be entered or changed in the tags input dialog.
True if the collection
contains at least one tag which can be shown in the dialog,
or if the is not null (i.e. the developer has defined a custom form to edit the document's tags).
Shows the tags input dialog, allows the user to enter/update the values of objects
contained in the collection.
True if document contains editable tags and the user accepted the dialog, false otherwise.
Reflows the current document.
If a handler has been assigned to the event, that handler is invoked.
Otherwise, the method is called.
True if no warnings occurred during document generation, false if there were warnings.
Generates the current document,
using the refresh mode.
true if no warnings occurred during document generation,
false if there were warnings (in that case, the property on the current document
contains the warnings that were issued).
Generates the current document.
Depending on the specified refresh mode, may update data-bound and calculated values.
A value indicating what data should be refreshed during generation.
true if no warnings occurred during document generation,
false if there were warnings (in that case, the property on the current document
contains the warnings that were issued).
Creates a new page and adds it to the document.
Note that property on the document must be set to true
for this method to work; otherwise, an exception will occur.
Specifies a layout which will be used for all following pages.
Indicates which page must be added - vertical or horizontal.
Creates a new page and adds it to the document.
Specifies a layout which will be used for all following pages.
Creates a new page and adds it to the document.
Begins a new column. If the current column is the last on the page then a new page will be started.
Note that AllowNonReflowableDocs property on the document must be set to true
for this method to work; otherwise, an exception will occur.
Begins a new line in inline flow, can be used only if current stacking is inline flow.
Note that AllowNonReflowableDocs property on the document must be set to true
for this method to work; otherwise, an exception will occur.
Starts a new document.
Finishes generation of a document.
Returns true if no warning occurs during generating.
Indicates whether rendering in the block flow is permitted now.
Indicates whether direct rendering is permitted now.
Indicates whether an inline paragraph is currently being created on the document.
Adds a into the block flow of the current document,
and resolves it.
This method can only be used if is true.
The to add to the block flow.
true if no warnings were generated by this call, false otherwise.
As all other RenderBlock..., RenderDirect... and RenderInline... methods,
This method can only be used between calls to and
on the current document, i.e. when the property is true.
Do not use this method if the document is generated with a call to the method.
Adds a to the of the current document
at a specific position on the current page, and resolves it.
This method can only be used if is true.
The horizontal (X) coordinate at which to render the object (cannot be auto).
The vertical (Y) coordinate at which to render the object (cannot be auto).
The object to render.
true if no warnings were generated by this call, false otherwise.
The specified coordinates ( and )
are assigned to the and properties
of the passed object.
As all other RenderBlock..., RenderDirect... and RenderInline... methods,
This method can only be used between calls to and
on the current document, i.e. when the property is true.
Do not use this method if the document is generated with a call to the method.
Adds a to the of the current document
at a specific position on the current page, and resolves it.
This method can only be used if is true.
The horizontal (X) coordinate at which to render the object (cannot be auto).
The vertical (Y) coordinate at which to render the object (cannot be auto).
The object to render.
The width of the object (if null, auto is used).
The height of the object (if null, auto is used).
true if no warnings were generated by this call, false otherwise.
The specified coordinates ( and )
are assigned to the and properties
of the passed object.
The specified dimensions ( and )
are assigned to the and properties
of the passed object.
As all other RenderBlock..., RenderDirect... and RenderInline... methods,
This method can only be used between calls to and
on the current document, i.e. when the property is true.
Do not use this method if the document is generated with a call to the method.
Adds an anchor ( or ) at the current position in the document.
Can be used only if is true.
A string assigned to the of the anchor.
A string assigned to the of the anchor.
Arbitrary data assigned to the of the anchor.
This method can only be used if the current document is being created using
the / methods
(i.e. if is true).
The type of anchor that this method creates depends on the current state of the document:
-
If an inline paragraph has been started
(e.g. with a call to or )
and has not been ended (e.g. with a call to ,
or any of the RenderBlock() or RenderDirect() methods),
this method creates a on the current paragraph.
-
Otherwise (if there's no current inline paragraph),
this method creates a at the current point in the block flow.
Adds an anchor ( or ) at the current position in the document.
Can be used only if is true.
This method is equivalent to
with the last parameter (user data) specified as null value.
A string assigned to the of the anchor.
A string assigned to the of the anchor.
Adds an anchor ( or ) at the current position in the document.
Can be used only if is true.
This method is equivalent to
with the last two parameters (description and user data) specified as null values.
A string assigned to the of the anchor.
Renders the RTF text.
Text to render, can be plain text.
If null then parent width will be used.
If null then autoheight will be used.
Style of object.
Returns true if no warnings occur during rendering the object.
Renders the RTF text with autoheight.
Text to render, can be plain text.
If null then parent width will be used.
Returns true if no warnings occur during rendering the object.
Renders the RTF text with parent width and autoheight.
Text to render, can be plain text.
Returns true if no warnings occur during rendering the object.
Renders the Image.
Image to render.
Width of an image box. If null then autowidth.
Height of an image box. If null then autoheight.
Style of the image. If null then the style for an image of document is used.
Returns true if no warnings occur during rendering the object.
Renders the Image.
Image to render.
Width of an image box. If null then autowidth.
Height of an image box. If null then autoheight.
Alignment of an image.
Returns true if no warnings occur during rendering the object.
Renders the Image.
Image to render.
Returns true if no warnings occur during rendering the object.
Renders a block of text into the block flow of the current document.
The text to render.
true if no warnings were generated by this call, false otherwise.
The width of the rendered block is set to the width of the page (or column for multi-column layouts),
which is equivalent to setting the of a to "parent.width".
The height of the rendered block is set to auto,
which is equivalent to setting the of a to
or "auto".
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a block of text into the block flow of the current document,
using the specified .
The text to render.
The style to use (can be null).
true if no warnings were generated by this call, false otherwise.
See for details on how the width and height of the
text block are set.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a block of text into the block flow of the current document,
using the specified font, text color and horizontal alignment.
The text to render.
The to use (can be null).
The text color to use.
The horizontal text alignment to use.
true if no warnings were generated by this call, false otherwise.
See for details on how the width and height of the
text block are set.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a block of text into the block flow of the current document,
using the specified font.
The text to render.
The to use (can be null).
true if no warnings were generated by this call, false otherwise.
See for details on how the width and height of the
text block are set.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a block of text into the block flow of the current document,
using the specified font and text color.
The text to render.
The to use (can be null).
The text color to use.
true if no warnings were generated by this call, false otherwise.
See for details on how the width and height of the
text block are set.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a block of text into the block flow of the current document,
using the specified font and horizontal alignment.
The text to render.
The to use (can be null).
The horizontal text alignment to use.
true if no warnings were generated by this call, false otherwise.
See for details on how the width and height of the
text block are set.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a block of text into the block flow of the current document,
using the specified horizontal alignment.
The text to render.
The horizontal text alignment to use.
true if no warnings were generated by this call, false otherwise.
See for details on how the width and height of the
text block are set.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a block of text into the block flow of the current document,
using the specified text color.
The text to render.
The text color to use.
true if no warnings were generated by this call, false otherwise.
See for details on how the width and height of the
text block are set.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a block of text with the specifed width and height
into the block flow of the current document,
using the specified .
The text to render.
The width of the block to render (if null, parent width is used).
The height of the block to render (if null, auto height is used).
The style to use (can be null).
true if no warnings were generated by this call, false otherwise.
See for details on how the width and height of the
text block are set.
This method can only be used between calls to and
methods on the current document.
For details, see .
Begins rendering of a new inline paragraph into the of the current document,
using the specified and dimensions.
The to use for the paragraph.
The width of the paragraph. If null, page (or column for multi-column layouts) width is used.
The height of the paragraph. If null, is used.
true if no warnings were generated by this call, false otherwise.
Use this method to set the , and
of the object
maintained internally to serve subsequent RenderInline... calls.
The specified parameters are in effect until the started paragraph is ended
by a call to , another ,
or any of the RenderBlock... or RenderDirect... methods.
It is not necessary to call this method in order to use other RenderInline... methods
(such as or ),
but calling this method allows to set the style and dimensions for the paragraph
that will be filled by subsequent RenderInline... calls.
This method can only be used between calls to and
methods on the current document.
For details, see .
Ends rendering of the current inline paragraph.
This method ends the current internally maintained object
used to serve any of RenderInline... calls.
It is not necessary to call this method in order to end the current paragraph,
it is also automatically ended by a call to
or any of the RenderBlock... or RenderDirect... methods.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a into the current inline paragraph.
The object to add to the of the current inline paragraph.
The paragraph width. Used only if this call begins a new paragraph (i.e. if there is no current one).
The paragraph height. Used only if this call begins a new paragraph (i.e. if there is no current one).
The to apply to the specified .
true if no warnings were generated by this call, false otherwise.
This method adds the specified to the current internally maintained object.
A new paragraph is started if there is no current one.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a string into the current inline paragraph,
using the specified style.
The string to add to the of the current inline paragraph.
The to apply to the specified text.
true if no warnings were generated by this call, false otherwise.
This method creates a new object
with the specified style,
and adds it to the current internally maintained object.
A new paragraph is started if there is no current one.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a string into the current inline paragraph,
using the specified font and text color.
The string to add to the of the current inline paragraph.
The font to use for the specified text.
The text color to use.
true if no warnings were generated by this call, false otherwise.
This method creates a new object
with the specified font and color,
and adds it to the current internally maintained object.
A new paragraph is started if there is no current one.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a string into the current inline paragraph,
using the specified font.
The string to add to the of the current inline paragraph.
The font to use for the specified text.
true if no warnings were generated by this call, false otherwise.
This method creates a new object
with the specified font,
and adds it to the current internally maintained object.
A new paragraph is started if there is no current one.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a string into the current inline paragraph,
using the specified text color.
The string to add to the of the current inline paragraph.
The text color to use.
true if no warnings were generated by this call, false otherwise.
This method creates a new object
with the specified text color,
and adds it to the current internally maintained object.
A new paragraph is started if there is no current one.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a string into the current inline paragraph,
using the specified font style.
The string to add to the of the current inline paragraph.
The to use for the text.
true if no warnings were generated by this call, false otherwise.
This method creates a new object
with the specified font style,
and adds it to the current internally maintained object.
A new paragraph is started if there is no current one.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a string into the current inline paragraph.
The string to add to the of the current inline paragraph.
true if no warnings were generated by this call, false otherwise.
This method creates a new object
and adds it to the current internally maintained object.
A new paragraph is started if there is no current one.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders an into the current inline paragraph.
The image to add to the of the current inline paragraph.
true if no warnings were generated by this call, false otherwise.
This method creates a new object
and adds it to the current internally maintained object.
A new paragraph is started if there is no current one.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders an into the current inline paragraph,
using the specified .
The image to add to the of the current inline paragraph.
The to use for the image.
true if no warnings were generated by this call, false otherwise.
This method creates a new object
and adds it to the current internally maintained object.
A new paragraph is started if there is no current one.
This method can only be used between calls to and
methods on the current document.
For details, see .
Creates an internally maintained object
that can be used to add graphics to the block flow of the current document.
This method always returns true.
Between the calls to this method and ,
use property to access the object
that can be used to draw on.
This method throws an exception if a call to RenderBlockGraphicsBegin without
a matching call to has already been issued.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds the internally maintained object
created with a previous call to to the
block flow of the current document.
true if no warnings were generated by this call, false otherwise.
Internally, this method calls ,
passing the as the parameter,
and resets the internal variable used to hold that value.
Renders an arc into the block flow of the current document.
The width of the arc.
The height of the arc.
The arc's starting angle (in degrees, measured clockwise from the X axis).
The arc's sweep angle (in degrees, measured clockwise from ).
The to use.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders an arc into the block flow of the current document.
The width of the arc.
The height of the arc.
The arc's starting angle (in degrees, measured clockwise from the X axis).
The arc's sweep angle (in degrees, measured clockwise from ).
The to draw the arc with.
The fill color.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders an arc into the block flow of the current document.
The width of the arc.
The height of the arc.
The arc's starting angle (in degrees, measured clockwise from the X axis).
The arc's sweep angle (in degrees, measured clockwise from ).
The to draw the arc with.
The fill brush.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders an arc into the block flow of the current document.
The width of the arc.
The height of the arc.
The arc's starting angle (in degrees, measured clockwise from the X axis).
The arc's sweep angle (in degrees, measured clockwise from ).
The to draw the arc with.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders an arc into the block flow of the current document.
The width of the arc.
The height of the arc.
The arc's starting angle (in degrees, measured clockwise from the X axis).
The arc's sweep angle (in degrees, measured clockwise from ).
The line color.
The line thickness.
The arc fill color.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders an arc into the block flow of the current document.
The width of the arc.
The height of the arc.
The arc's starting angle (in degrees, measured clockwise from the X axis).
The arc's sweep angle (in degrees, measured clockwise from ).
The line color.
The line thickness.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders an ellipse into the block flow of the current document.
The width of the ellipse.
The height of the ellipse.
The to use.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders an ellipse into the block flow of the current document.
The width of the ellipse.
The height of the ellipse.
The to draw the ellipse with.
The ellipse fill color.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders an ellipse into the block flow of the current document.
The width of the ellipse.
The height of the ellipse.
The to draw the ellipse with.
The ellipse fill brush.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders an ellipse into the block flow of the current document.
The width of the ellipse.
The height of the ellipse.
The to draw the ellipse with.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders an ellipse into the block flow of the current document.
The width of the ellipse.
The height of the ellipse.
The line color.
The line thickness.
The ellipse fill color.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders an ellipse into the block flow of the current document.
The width of the ellipse.
The height of the ellipse.
The line color.
The line thickness.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a pie into the block flow of the current document.
The width of the pie.
The height of the pie.
The pie's starting angle (in degrees, measured clockwise from the X axis).
The pie's sweep angle (in degrees, measured clockwise from ).
The to use.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a pie into the block flow of the current document.
The width of the pie.
The height of the pie.
The pie's starting angle (in degrees, measured clockwise from the X axis).
The pie's sweep angle (in degrees, measured clockwise from ).
The to draw the pie with.
The fill color.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a pie into the block flow of the current document.
The width of the pie.
The height of the pie.
The pie's starting angle (in degrees, measured clockwise from the X axis).
The pie's sweep angle (in degrees, measured clockwise from ).
The to draw the pie with.
The fill brush.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a pie into the block flow of the current document.
The width of the pie.
The height of the pie.
The pie's starting angle (in degrees, measured clockwise from the X axis).
The pie's sweep angle (in degrees, measured clockwise from ).
The to draw the pie with.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a pie into the block flow of the current document.
The width of the pie.
The height of the pie.
The pie's starting angle (in degrees, measured clockwise from the X axis).
The pie's sweep angle (in degrees, measured clockwise from ).
The line color.
The line thickness.
The fill color.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a pie into the block flow of the current document.
The width of the pie.
The height of the pie.
The pie's starting angle (in degrees, measured clockwise from the X axis).
The pie's sweep angle (in degrees, measured clockwise from ).
The line color.
The line thickness.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a rectangle into the block flow of the current document.
The width of the rectangle.
The height of the rectangle.
The to use.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a rectangle into the block flow of the current document.
The width of the rectangle.
The height of the rectangle.
The to draw the rectangle with.
The fill color.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a rectangle into the block flow of the current document.
The width of the rectangle.
The height of the rectangle.
The to draw the rectangle with.
The fill brush.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a rectangle into the block flow of the current document.
The width of the rectangle.
The height of the rectangle.
The to draw the rectangle with.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a rectangle into the block flow of the current document.
The width of the rectangle.
The height of the rectangle.
The line color.
The line thickness.
The fill color.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a rectangle into the block flow of the current document.
The width of the rectangle.
The height of the rectangle.
The line color.
The line thickness.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a horizontal line with the specified width, starting at the left of the page,
into the block flow of the current document.
The width of the line.
The used to draw the line.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders a vertical line with the specified height, starting at the current position,
into the block flow of the current document.
The height of the line.
The used to draw the line.
true if no warnings were generated by this call, false otherwise.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an RTF-formatted string to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the text (cannot be auto).
The vertical (Y) coordinate at which to render the text (cannot be auto).
The RTF-formatted string to render.
The width of the text area (cannot be null or auto).
The height of the text area (can be null, in which case is used).
The to use, or null.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an RTF-formatted string to the of the current document
at a specific position on the current page with auto height, and resolves it.
The horizontal (X) coordinate at which to render the text (cannot be auto).
The vertical (Y) coordinate at which to render the text (cannot be auto).
The RTF-formatted string to render.
The width of the text area (cannot be null or auto).
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the image (cannot be auto).
The vertical (Y) coordinate at which to render the image (cannot be auto).
The image to render.
The width of the image (if null, auto is used).
The height of the image (if null, auto is used).
The to use, or null.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the image (cannot be auto).
The vertical (Y) coordinate at which to render the image (cannot be auto).
The image to render.
The width of the image (if null, auto is used).
The height of the image (if null, auto is used).
The image alignment to use.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the image (cannot be auto).
The vertical (Y) coordinate at which to render the image (cannot be auto).
The image to render.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a text to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the image (cannot be auto).
The vertical (Y) coordinate at which to render the image (cannot be auto).
The string to render.
The width of the text area (if null, auto is used).
The height of the text area (if null, auto is used).
The to use, or null.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a text to the of the current document
at a specific position on the current page, with auto height, and resolves it.
The horizontal (X) coordinate at which to render the image (cannot be auto).
The vertical (Y) coordinate at which to render the image (cannot be auto).
The string to render.
The width of the text area (if null, auto is used).
The font to use.
The text color.
The horizontal text alignment.
This method can only be used between calls to and
methods on the current document.
For details, see .
Creates an internally maintained object
that can be used to add graphics at a specific position to the
of the document on the current page.
The horizontal (X) coordinate on the current page.
The vertical (Y) coordinate on the current page.
Between the calls to this method and ,
use property to access the object
that can be used to draw on.
This method throws an exception if a call to RenderDirectGraphicsBegin without
a matching call to has already been issued.
This method can only be used between calls to and
methods on the current document.
For details, see .
Renders the internally maintained object
created with a previous call to
onto the current page of the document.
Internally, this method calls ,
passing the as the parameter,
and resets the internal variable used to hold that value.
The coordinates at which is rendered
are determined by the preceding call to .
Adds an arc to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the arc (cannot be auto).
The vertical (Y) coordinate at which to render the arc (cannot be auto).
The width of the arc.
The height of the arc.
The arc's starting angle (in degrees, measured clockwise from the X axis).
The arc's sweep angle (in degrees, measured clockwise from ).
The to use.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an arc to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the arc (cannot be auto).
The vertical (Y) coordinate at which to render the arc (cannot be auto).
The width of the arc.
The height of the arc.
The arc's starting angle (in degrees, measured clockwise from the X axis).
The arc's sweep angle (in degrees, measured clockwise from ).
The to draw the arc with.
The fill color.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an arc to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the arc (cannot be auto).
The vertical (Y) coordinate at which to render the arc (cannot be auto).
The width of the arc.
The height of the arc.
The arc's starting angle (in degrees, measured clockwise from the X axis).
The arc's sweep angle (in degrees, measured clockwise from ).
The to draw the arc with.
The fill brush.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an arc to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the arc (cannot be auto).
The vertical (Y) coordinate at which to render the arc (cannot be auto).
The width of the arc.
The height of the arc.
The arc's starting angle (in degrees, measured clockwise from the X axis).
The arc's sweep angle (in degrees, measured clockwise from ).
The to draw the arc with.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an arc to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the arc (cannot be auto).
The vertical (Y) coordinate at which to render the arc (cannot be auto).
The width of the arc.
The height of the arc.
The arc's starting angle (in degrees, measured clockwise from the X axis).
The arc's sweep angle (in degrees, measured clockwise from ).
The line color.
The line thickness.
The fill color.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an arc to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the arc (cannot be auto).
The vertical (Y) coordinate at which to render the arc (cannot be auto).
The width of the arc.
The height of the arc.
The arc's starting angle (in degrees, measured clockwise from the X axis).
The arc's sweep angle (in degrees, measured clockwise from ).
The line color.
The line thickness.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an ellipse to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the ellipse (cannot be auto).
The vertical (Y) coordinate at which to render the ellipse (cannot be auto).
The width of the ellipse.
The height of the ellipse.
The to use.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an ellipse to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the ellipse (cannot be auto).
The vertical (Y) coordinate at which to render the ellipse (cannot be auto).
The width of the ellipse.
The height of the ellipse.
The to draw the ellipse with.
The fill color.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an ellipse to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the ellipse (cannot be auto).
The vertical (Y) coordinate at which to render the ellipse (cannot be auto).
The width of the ellipse.
The height of the ellipse.
The to draw the ellipse with.
The fill brush.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an ellipse to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the ellipse (cannot be auto).
The vertical (Y) coordinate at which to render the ellipse (cannot be auto).
The width of the ellipse.
The height of the ellipse.
The to draw the ellipse with.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an ellipse to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the ellipse (cannot be auto).
The vertical (Y) coordinate at which to render the ellipse (cannot be auto).
The width of the ellipse.
The height of the ellipse.
The line color.
The line thickness.
The fill color.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds an ellipse to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the ellipse (cannot be auto).
The vertical (Y) coordinate at which to render the ellipse (cannot be auto).
The width of the ellipse.
The height of the ellipse.
The line color.
The line thickness.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a pie to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the pie (cannot be auto).
The vertical (Y) coordinate at which to render the pie (cannot be auto).
The width of the pie.
The height of the pie.
The pie's starting angle (in degrees, measured clockwise from the X axis).
The pie's sweep angle (in degrees, measured clockwise from ).
The to use.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a pie to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the pie (cannot be auto).
The vertical (Y) coordinate at which to render the pie (cannot be auto).
The width of the pie.
The height of the pie.
The pie's starting angle (in degrees, measured clockwise from the X axis).
The pie's sweep angle (in degrees, measured clockwise from ).
The to draw the pie with.
The fill color.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a pie to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the pie (cannot be auto).
The vertical (Y) coordinate at which to render the pie (cannot be auto).
The width of the pie.
The height of the pie.
The pie's starting angle (in degrees, measured clockwise from the X axis).
The pie's sweep angle (in degrees, measured clockwise from ).
The to draw the pie with.
The fill brush.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a pie to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the pie (cannot be auto).
The vertical (Y) coordinate at which to render the pie (cannot be auto).
The width of the pie.
The height of the pie.
The pie's starting angle (in degrees, measured clockwise from the X axis).
The pie's sweep angle (in degrees, measured clockwise from ).
The to draw the pie with.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a pie to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the pie (cannot be auto).
The vertical (Y) coordinate at which to render the pie (cannot be auto).
The width of the pie.
The height of the pie.
The pie's starting angle (in degrees, measured clockwise from the X axis).
The pie's sweep angle (in degrees, measured clockwise from ).
The line color.
The line thickness.
The fill color.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a pie to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the pie (cannot be auto).
The vertical (Y) coordinate at which to render the pie (cannot be auto).
The width of the pie.
The height of the pie.
The pie's starting angle (in degrees, measured clockwise from the X axis).
The pie's sweep angle (in degrees, measured clockwise from ).
The line color.
The line thickness.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a rectangle to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the rectangle (cannot be auto).
The vertical (Y) coordinate at which to render the rectangle (cannot be auto).
The width of the rectangle.
The height of the rectangle.
The to use.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a rectangle to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the rectangle (cannot be auto).
The vertical (Y) coordinate at which to render the rectangle (cannot be auto).
The width of the rectangle.
The height of the rectangle.
The to draw the rectangle with.
The fill color.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a rectangle to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the rectangle (cannot be auto).
The vertical (Y) coordinate at which to render the rectangle (cannot be auto).
The width of the rectangle.
The height of the rectangle.
The to draw the rectangle with.
The fill brush.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a rectangle to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the rectangle (cannot be auto).
The vertical (Y) coordinate at which to render the rectangle (cannot be auto).
The width of the rectangle.
The height of the rectangle.
The to draw the rectangle with.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a rectangle to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the rectangle (cannot be auto).
The vertical (Y) coordinate at which to render the rectangle (cannot be auto).
The width of the rectangle.
The height of the rectangle.
The line color.
The line thickness.
The fill color.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a rectangle to the of the current document
at a specific position on the current page, and resolves it.
The horizontal (X) coordinate at which to render the rectangle (cannot be auto).
The vertical (Y) coordinate at which to render the rectangle (cannot be auto).
The width of the rectangle.
The height of the rectangle.
The line color.
The line thickness.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a line to the of the current document
at a specific position on the current page, and resolves it.
The X coordinate of the first point that the line connects.
The Y coordinate of the first point that the line connects.
The X coordinate of the second point that the line connects.
The Y coordinate of the second point that the line connects.
The to draw the line with.
This method can only be used between calls to and
methods on the current document.
For details, see .
Adds a line to the of the current document
at a specific position on the current page, and resolves it.
The X coordinate of the first point that the line connects.
The Y coordinate of the first point that the line connects.
The X coordinate of the second point that the line connects.
The Y coordinate of the second point that the line connects.
The line color.
The line thickness.
This method can only be used between calls to and
methods on the current document.
For details, see .
Creates a from a collection of
objects, and renders it on the current page,
at position specified by the points' coordinates.
The collection of objects
(an exception occurs if an object that is not a is found in the collection).
A value indicating whether the polygon should be closed (i.e. the last point connected to the first one).
The to use.
This method can only be used between calls to and
methods on the current document.
For details, see .
Creates a from a collection of
objects, and renders it on the current page,
at position specified by the points' coordinates.
If specifies a non-empty and non-transparent color,
the polygon is closed, otherwise it is open.
The collection of objects
(an exception occurs if an object that is not a is found in the collection).
The to draw the polygon with.
The fill color (if empty or transparent, the polygon is closed, otherwise it is open).
This method can only be used between calls to and
methods on the current document.
For details, see .
Creates a from a collection of
objects, and renders it on the current page,
at position specified by the points' coordinates.
If is null, the polygon is open, otherwise it is closed.
The collection of objects
(an exception occurs if an object that is not a is found in the collection).
The to draw the polygon with.
The fill color (if null, the polygon is open, otherwise it is closed).
This method can only be used between calls to and
methods on the current document.
For details, see .
Creates an open from a collection of
objects, and renders it on the current page,
at position specified by the points' coordinates.
The collection of objects
(an exception occurs if an object that is not a is found in the collection).
The to draw the polygon with.
This method can only be used between calls to and
methods on the current document.
For details, see .
Creates a from a collection of
objects, and renders it on the current page,
at position specified by the points' coordinates.
If specifies a non-empty and non-transparent color,
the polygon is closed, otherwise it is open.
The collection of objects
(an exception occurs if an object that is not a is found in the collection).
The line color.
The line thickness.
The fill color (if empty or transparent, the polygon is closed, otherwise it is open).
This method can only be used between calls to and
methods on the current document.
For details, see .
Creates an open from a collection of
objects, and renders it on the current page,
at position specified by the points' coordinates.
The collection of objects
(an exception occurs if an object that is not a is found in the collection).
The line color.
The line thickness.
This method can only be used between calls to and
methods on the current document.
For details, see .
Creates a new instance of the class,
and imports a RDL report definition into created document.
The name of the file containing the report definition.
The that was created.
Imports a RDL report definition into the current document.
The name of the file containing the report definition.
Creates a new instance of the class
representing the specified .
The name of the file containing the report definition.
The name of the report in .
The that was created.
Imports a report definition into the current document.
The name of the file containing the report definition.
The name of the report in .
Exports the document to a disk file.
The output file name. The file extension determines the export format.
The range of pages to export (use null to export all pages).
Flag indicating whether to show the progress dialog.
Exports the document to a disk file.
The output file name. The file extension determines the export format.
Flag indicating whether to show the progress dialog.
Exports the document to a disk file.
The output file name. The file extension determines the export format.
Exports the document to a stream.
The destination stream.
The export provider. Use any of the static export providers available on
the C1.C1Preview.Export.ExportProviders class.
Flag indicating whether to show the progress dialog.
Exports the document to a stream.
The destination stream.
The export provider. Use any of the static export providers available on
the C1.C1Preview.Export.ExportProviders class.
Exports the document to a disk file.
The output file name. The file extension determines the export format.
The export provider. Use any of the static export providers available on
the C1.C1Preview.Export.ExportProviders class.
The range of pages to export (use null to export all pages).
Flag indicating whether to show the progress dialog.
Exports the document to a stream.
The destination stream.
The export provider. Use any of the static export providers available on
the C1.C1Preview.Export.ExportProviders class.
The range of pages to export (use null to export all pages).
Flag indicating whether to show the progress dialog.
Prints the current document with default printer settings,
not showing the print progress dialog.
Prints the current document with specified printer settings,
not showing the print progress dialog.
The printer settings to use.
Prints the document with specified printer settings,
optionally showing the print progress dialog.
The printer settings to use.
Flag indicating whether to show the print progress dialog.
Prints a range of pages of the current document with specified printer settings,
not showing the print progress dialog.
The printer settings to use.
The range of pages to export (use null to export all pages).
Prints a range of pages of the current document with specified printer settings,
optionally showing the print progress dialog.
The printer settings to use.
The range of pages to export (use null to export all pages).
Flag indicating whether to show the progress dialog.
Prints a range of pages of the current document with specified printer and default page settings,
not showing the print progress dialog.
The printer settings to use.
The default page settings to use.
The range of pages to export (use null to export all pages).
Prints the current document with specified printer and default page settings,
optionally showing the print progress dialog.
The printer settings to use.
The default page settings to use.
Flag indicating whether to show the progress dialog.
Prints a range of pages of the current document with specified printer and default page settings,
optionally showing the print progress dialog.
The printer settings to use.
The default page settings to use.
The range of pages to export (use null to export all pages).
Flag indicating whether to show the progress dialog.
Shows the standard print dialog, allowing the user to print the current document.
true if the document was printed, false otherwise.
Shows the standard print dialog, allowing the user to print the current document.
The printer settings to use.
The list of selected page numbers.
If this parameter is not null, selection option is enabled in the dialog.
Indicates whether to show print progress.
true if the document was printed, false otherwise.
Advances the current block flow position by the specified distance.
The amount by which to advance the block flow position (can be negative).
The specified must specify an absolute value (i.e. it cannot be an expression or percentage),
but it may be negative to move the current block flow position up on the current page.
This method can only be used between calls to and
methods on the current document.
Returns a representing the specified page.
The 1-based page number.
The representing the specified page, or null if the page was not found.
Converts an absolute length represented by a object
to a double value expressed in the current document's units.
The length to convert. If it is expressed in ,
the current document's units are used.
The font to use if is expressed in
, or
(otherwise, it can be null).
The converted double value.
Converts an absolute length represented by a object
to a double value expressed in the current document's units.
The length to convert. If it is expressed in ,
the current document's units are used.
The providing the font, required if is expressed in
, or
(otherwise, it can be null).
that should be used to get calculated properties.
The converted double value.
Searches for an with the specified in the current document.
The name to search for.
A object containing information about the found anchor, or null if none was found.
Searches for the first occurrence of a object in the current document.
The 0-based index of the page to start the search at.
Specifies whether to search forward or backward.
The object that was found, or null.
Gets or sets the object
applied to the first page of the document.
Gets or sets a value indicating how font embedding and substitution are handled
by the current .
For details on the available options see members of the
enumeration.
Note that if this property is set to a value other than
or
(i.e. fonts are not embedded automatically),
you may manually add certain fonts that you want embedded,
to the document's collection.
The default value of this property is .
Gets the collection of fonts embedded in the current document.
If property on the document
has been set to or
,
this collection is populated automatically when the document generates.
Otherwise, this collection is not populated automatically. But you can
add fonts to this collection in code, so that just the added fonts will be
embedded in the document. Note that in that case you must also explicitly
specify the glyphs to include by calling the
method or any of its overloads.
This property is obsolete.
Gets or sets a value indicating whether the
collection will be automatically filled with fonts used in the document
during document generation.
The default value is false.
Gets or sets the value limiting the maximum number of pages
in the generated document.
The default value is -1, indicating that the number of pages
in the document is unlimited.
This property is only taken into account when the document is
created using the method.
Gets the document creation mode.
Gets or sets the resolution (DPI) used during document creation.
Note that if is ,
this is also the resolution of ResolvedUnit pixels.
Gets or sets the object used when the document is created.
That Graphics is used to calculate text sizes, measure RTF text, and so on.
Gets the current busy state of the current document.
Gets or sets the type of metafiles created by the current document.
The default is .
Gets or sets the object containing the information
about the current document (such as author, company, and so on).
Gets or sets the value that will be used
to specify the resolved sizes of objects within the current document
(e.g. the sizes of objects representing the
render objects in the document).
This property cannot be changed when the document is generating
(i.e. while returns true).
Gets or sets the default page layout for the current document.
This property is a shortcut for .
(A page layout includes page settings, page headers and footers, and column definitions.)
Gets the collection of page layouts used in the current document.
In addition to the default layout which is always present, special layouts
may be defined for first, last, even and odd pages of the document.
The effective layout for each page is then produced by merging all applicable layouts.
Gets or sets the top-level stacking rule for the document body.
The default value is .
Gets or sets the default unit of measurement for the current document.
This unit is used when sizes or coordinates of objects within the document
are set without specifying the unit of measurement explicitly.
The default value is .
Gets the object representing the body of the current document.
Gets the representing the collection
of user-defined objects in the current document.
Gets or sets the string used as the opening parentheses when including references to objects
in the current document's texts (e.g. in or ).
To include a TagOpenParen string itself in a text, prepend it with the string.
The default value is "[".
Gets or sets the string used as the closing parentheses when including references to objects
in the current document's texts (e.g. in or ).
To include a TagCloseParen string itself in a text, prepend it with the string.
The default value is "]".
Gets or sets the string that can be used to escape and .
To include a TagEscapeString string itself in a text, duplicate it.
The default value is "\".
Gets or sets a value indicating whether an exception should be raised if an error occurs
while the current document generates.
If this property is false, the method will return false
if errors occurred while generating, otherwise an exception will be thrown
on the first error.
The default value is false.
Gets or sets a value indicating whether methods can be called on the current document
that would result in the document becoming non-reflowable (such as ).
If this property is false, calling such methods throws an exception.
If this property is true, calling such methods sets the
flag to false on the current document.
The default value is false.
Gets or sets a value indicating whether to clip the content
of the current document to page margins.
The default value is false.
Gets or sets a value indicating whether the end user should be prevented
from reflowing the document with different page settings.
This property is only a hint to the document viewer.
The default value is false (i.e. reflow is allowed).
Gets or sets a value indicating whether text in the current document
should be rendered using the GDI+ text API.
The default value is false.
Gets or sets a value indicating whether the current
should handle Windows messages while generating.
The default value is false.
Setting this property to true allows users to resize forms, click buttons, etc. while documents are
being generated. This makes applications more responsive, and is necessary if you want to provide a
"Cancel" button to stop the document generation (otherwise the user wouldn't be able to click the
button until the generation is complete).
Setting this property to false will cause documents to generate slightly faster.
The code below implements "Generate" and "Cancel" buttons attached to a .
The "Generate" button checks whether the document is busy before starting to generate it.
This is necessary because the user could click the "Generate" button several times in a row, before the document got a
chance to finish generating. (Calling the method while the component is busy throws an
exception.)
The "Cancel" button checks whether the document is currently generating, and sets the
property to true if it is.
_doc.DoEvents = true;
private void Generate_Click(object sender, EventArgs e)
{
if (_doc.BusyState != BusyStateEnum.Ready)
Console.WriteLine("Cannot generate now, document is busy");
else
_doc.Generate();
}
private void Cancel_Click(object sender, EventArgs e)
{
if (_doc.BusyState != BusyStateEnum.Ready)
_doc.Cancel = true;
else
Console.WriteLine("Document is not generating, nothing to cancel");
}
Gets the main (root) of the current document.
Gets the representing the collection of
objects of the current document.
Gets the current document's .
The Dictionary can be used to contain reused resources
(e.g. images used in multiple places in the document).
Gets or sets the action to be performed when the TAB key is pressed
in a C1.Win.C1Preview.C1PreviewPane control which is viewing the current document.
The default value is .
Gets or sets the action to be performed when the ENTER key is pressed
in a C1.Win.C1Preview.C1PreviewPane control which is viewing the current document.
The default value is .
Gets or sets a value specifying
the look and feel of input controls in the current document
(see types derived from ).
The default value is .
Gets or sets a value indicating whether to add messages to the
current document's collection
when script errors are found.
The default value is false.
Gets or sets a value indicating whether a dialog allowing to input values for some or all
of the user defined tags (elements of the collection) should be shown
to the user before the document generates. To include or exclude tags from the dialog,
use .
The default value is false.
Gets or sets the type of form used to input tag values
(the form will be shown if is true).
The form type must be derived from .
Gets or sets the type name of form used to input tag values
(the form will be shown if is true).
The form type must be derived from .
Gets or sets a value indicating whether a log should be built
during serialization and deserialization operations.
If an exception occurs, that log is available in the exception data.
Set this property to true to help debugging obscure serialization errors.
Gets a string representing the version of the document persistence format
supported by the current assembly.
This version is used to check persisted documents' compatibility.
Versions are backwards-compatible, but not vice versa
(i.e. a document persisted using a newer version of
may be unreadable by an older version).
Gets a object representing the version of the document persistence format
supported by the current assembly.
This version is used to check persisted documents' compatibility.
Versions are backwards-compatible, but not vice versa
(i.e. a document persisted using a newer version of
may be unreadable by an older version).
Gets or sets a value indicating whether the default page settings are
retrieved from the default printer (may slow things down if the printer
is a network one) or calculated based on the current locale.
Gets the resolution (DPI) of the object.
Gets or sets the name of the printer used to provide
used to measure/calculate layouts of objects.
This property is only used if is set to .
Gets or sets the type of device used to provide
used to measure/calculate layouts of objects.
If this property is set to ,
specifies the printer.
Gets the object
used to measure/calculate layouts of objects.
Occurs when the property value has changed.
Occurs when the property value has changed.
Occurs periodically during document generation.
Allows to provide progress indication and the ability to cancel generation to the user.
Occurs when the property value has changed.
Gets a value indicating whether all pages have been added to the document
being generated.
For example, if the document has a page footer or header
that includes the total page count (of the kind "Page X of Y"), this property
gets false while new pages are being added, but true when adding
new pages is over and the total page count is being updated on the rendered
pages.
If the document is currently not generating (see ),
gets true.
If the current document is generating (see ),
gets the approximate completion ratio, from 0 (0% complete) to 1 (100% complete).
If the document is currently not generating, gets 1.
Gets or sets arbitrary data associated with the current document.
Gets the collection of objects describing fonts
used in the current document.
This collection is populated automaticallly when the document generates,
depending on the value of the
property on the document.
Gets the collection of system tags (objects derived from ) associated with the current document.
Gets the object containing information related to the
current document's usage: date/time of generation, file name last used to
save or load the document, and so on.
Gets the value indicating whether a handler is attached to the
event of the current document.
Gets the collection of all registered objects.
Gets the effective layout for the current page. That layout is automatically
built on the fly by merging all applicable layouts defined for the current document in .
You may change the properties on CurrentPageLayout programmatically. The changes will be
effective immediately if they are made in the event handler,
otherwise they will take effect for the next added page.
Note that this property is only available during document generation, at other times null is returned.
Gets the object representing the
accept button in the current document
(the first object with property set to true).
Gets the current object
created by the last call to .
Gets the current Graphics object
created by the last call to .
Gets the current object
created by the last call to .
Gets the current Graphics object
created by the last call to .
Indicates whether the document is currently being generated.
Gets a value indicating whether the document is being generated
via / methods.
Gets a value indicating whether the document is reflowable.
Gets the collection of warnings produced by the document's generation.
Obsolete. Now gets the Code of the first element in the Warnings collection,
or GenerateErrorEnum.None if there are no warnings.
Obsolete. Now gets the description of the first element in the Warnings collection,
or an empty string if there are no warnings.
Gets the collection of document's pages.
Gets the object representing
the data schema built into the current document.
Gets or sets a value indicating whether to cancel the generation of the current document.
Note that this property is useful only if
is set to true.
Setting this property to true can only be done while the current document is
being generated (i.e. the value of the property is
equal to ). An attempt to set this property
to true when the document is not being generated will cause an exception.
Gets the current generating page, returns null if document in not generating state.
Gets the current generating area of page, returns null if document in not generating state.
An amount of available vertical space in the block flow in the currently
generating page area, value specified in the ResolvedUnit units.
Returns -1 if document in not generating state.
An amount of available horizontal space in the block flow in the currently
generating page area, value specified in the ResolvedUnit units.
Returns -1 if document in not generating state.
Gets the ScriptingOptions object defining the scripting options of this C1PrintDocument object.
Gets the CompatibilityOptions object which determines compatibility
with previous versions of C1PrintDocument.
Gets the file name associated with the current document
(i.e. the document was either loaded from that file, or
saved to it).
Gets the directory of the .
Gets or sets the script that is executed when the current document starts generating.
also fires the event at this time.
The difference between events and scripts is that event handlers
belong to the application code, while scripts belong to the document.
Thus it is recommended that event handlers be used to perform tasks that
implement the overall application logic but do not depend on the
specific document being processed.
On the other hand, scripts should be used to perform tasks directly related
to the document itself. Scripts attached to a document are executed regardless
of the current application (e.g. when the document is regenerated after
being loaded from file by a different program).
(For example, a document might contain a script that changes the value
of a field in that document when an error occurs.)
Gets or sets the script that is executed when the current document has finished generating.
also fires the event at this time.
The difference between events and scripts is that event handlers
belong to the application code, while scripts belong to the document.
Thus it is recommended that event handlers be used to perform tasks that
implement the overall application logic but do not depend on the
specific document being processed.
On the other hand, scripts should be used to perform tasks directly related
to the document itself. Scripts attached to a document are executed regardless
of the current application (e.g. when the document is regenerated after
being loaded from file by a different program).
(For example, a document might contain a script that changes the value
of a field in that document when an error occurs.)
Gets or sets the script that is executed when a new page is added to the document.
This script executes after the page has been added to the collection
but before it is resolved (i.e. when the content of the page has not been laid out yet).
This script should be used only to change the page layout. Do not use this script
to change the page content, as it may cause errors.
also fires the event at this time.
The difference between events and scripts is that event handlers
belong to the application code, while scripts belong to the document.
Thus it is recommended that event handlers be used to perform tasks that
implement the overall application logic but do not depend on the
specific document being processed.
On the other hand, scripts should be used to perform tasks directly related
to the document itself. Scripts attached to a document are executed regardless
of the current application (e.g. when the document is regenerated after
being loaded from file by a different program).
(For example, a document might contain a script that changes the value
of a field in that document when an error occurs.)
Gets or sets the script that is executed when an error occurs in a script attached to the current document.
The event is also fired at the same time
as this script is executed.
The difference between events and scripts is that event handlers
belong to the application code, while scripts belong to the document.
Thus it is recommended that event handlers be used to perform tasks that
implement the overall application logic but do not depend on the
specific document being processed.
On the other hand, scripts should be used to perform tasks directly related
to the document itself. Scripts attached to a document are executed regardless
of the current application (e.g. when the document is regenerated after
being loaded from file by a different program).
(For example, a document might contain a script that changes the value
of a field in that document when an error occurs.)
Gets the version of C1PrintDocument assembly.
Occurs when the document generation is started.
Occurs when the document generation completes.
Occurs when a new empty page is created and added to the document,
the page is added to the Pages collection but *not resolved*,
use this method only for changing layout of page.
Occurs only during generating of the document,
when generating of page of document is finished, page is added to the Pages collection
and switch to other page is occured.
Occurs when page of document is changed.
This event occurs very often while document is generating,
it is called each time when a fragment of object is
added to page or removed from page.
Occurs only during generating of the document, when page
of document which was added to document is changed, for example when
page numbering is changed or PageCount property is updated for page.
Occurs when the page is removed from the document (from the Pages collection).
This event cannot occur during document generation.
Occurs when the Pages collection is cleared.
Occurs before the Pages collection is cleared.
Allows user to build document content in event handler.
Occurs when the value of RenderInputBase object within document is changed.
Occurs when the FormsStyle property value changes.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
The base class for types of objects that can be inserted in a 's .
Derived classes include and .
Represents an element of a .
For internal use only.
Elements of an must implement this interface.
Gets or sets the owner of the collection item.
For internal use.
Sets the name of the current item.
The new name of the item.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Creates a copy of the current object.
Note that the property is not copied to the new object.
The newly created object.
Gets the containing the current object.
Gets or sets the unique name of the current object.
If an item with the specified name already exists in the collection,
an exception is thrown.
Initializes a new instance of the class.
The name of the .
Overridden. Sets the name of the current item.
The new name.
Gets the object that is the owner of the current item.
Represents a dictionary within a .
The dictionary allows to store an object such as an image or an icon once,
and reuse it throughout the document.
Items contained in the dictionary must have types derived from
(e.g. or ).
Represents an of uniquely-named elements.
Describes a collection with an owner.
Base class for and .
Additional to updates Owner property
of items if they supports interface.
Represents a collection with an owner object.
Notifies the owner of interesting events on the collection if the owner
supports the interface.
Initializes a new instance of the class.
Initializes a new instance of the class.
The collection owner.
Called when the collection is about to be cleared.
Called after the collection has been cleared.
Called when an item is about to be iserted.
The item index.
The item.
Called after an item has been inserted.
The item index.
The item.
Called when an item is about to be removed.
The item index.
The item.
Called after an item has been removed.
The item index.
The item.
Called when an item is about to be set.
The item index.
The old item.
The new item.
Called after an item has been set.
The item index.
The old item.
The new item.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Clears the current collection, and copies the items from another one.
The items are copied by cloning, and must support the
interface (if an item that does not support is encountered, an exception occurs).
The to copy items from.
Searches for the specified Object and returns the zero-based index
of the first occurrence within the entire collection.
The Object to locate in the collection. The value can be a null reference.
The zero-based index of the first occurrence of value within the entire collection, if found; otherwise, -1.
Swap two items in collection.
Index of first item.
Index of second item.
Gets the owner of collection.
Initializes a new instance of the class.
Initializes a new instance of the class.
The collection owner.
Called when the collection is about to be cleared.
Called when an item is about to be iserted.
The item index.
The item.
Called after an item has been inserted.
The item index.
The item.
Called after an item has been removed.
The item index.
The item.
Called when an item is about to be set.
The item index.
The old item.
The new item.
Called after an item has been set.
The item index.
The old item.
The new item.
Gets the type of items in the collection.
If this method returns null, items of different types can be added to the collection.
Otherwise, only items of the type this method returns can be added.
Gets the owner of collection.
Initializes a new instance of the class.
The collection owner.
Gets the type of collection elements.
The type.
Called after the collection has been cleared.
Called after an item has been removed.
The item index.
The item.
Called after an item has been set.
The item index.
The old item.
The new item.
Called when an item is about to be set.
The item index.
The old item.
The new item.
Called when an item is about to be iserted.
The item index.
The item.
Returns the 0-based index of a
with specified name in the current .
The name of the item to locate.
The 0-based index of the specified item, or -1 if the item was not found.
Returns with specified name.
The name of the item to locate.
The specified item
Gets the type of items that can be added to this dictionary.
The type.
Adds an item to the current dictionary.
The to add.
The index of the newly added item in the current dictionary.
Removes an item from the current dictionary.
The to remove.
Gets the object that is the owner of the current dictionary.
Gets the with the specified name.
Gets or sets the at the specified index.
Represents an stored in a .
Initializes a new instance of the class.
Initializes a new instance of the class.
The name of the current item.
Initializes a new instance of the class.
The name of the current item.
The image to store in the current item.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Indicates whether the OpenXmlImage property should be serialized.
True if OpenXmlImage should be serialized, false otherwise.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets the stored by the current .
Represents an stored in a .
Initializes a new instance of the class.
Initializes a new instance of the class.
The name of the current item.
Initializes a new instance of the class.
The name of the current item.
The icon to store in the current item.
Indicates whether the property should be serialized.
True if should be serialized, false otherwise.
Indicates whether the OpenXmlIcon property should be serialized.
True if OpenXmlIcon should be serialized, false otherwise.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets the stored by the current .
For internal use only.
This interface should be implemented by a class if it needs to hold a link (reference)
to an object in a .
Gets the where the is stored.
The base class describing a link (reference) to a .
Provides the base functionality, derived classes such as and
represent links to specific type of dictionary items.
Initializes a new instance of the class.
The owner of this instance.
Gets the data representing the item.
The data representing the item.
Assigns (copies) properties from another to the current object.
Gets the owner of the current dictionary item.
Gets object containing the curret dictionary item.
Gets or sets data representing the object stored in the dictionary.
Gets or sets the name of the item in the dictionary.
Gets a value indicating whether contains data.
Specializes the class to represent a link to an .
Initializes a new instance of the class.
The owner of this instance.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
For internal use.
For internal use.
Gets the data representing the item.
The data representing the item.
Gets or sets the associated with the current item.
Specializes the class to represent a link to an .
Initializes a new instance of the class.
The owner of this instance.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
For internal use.
Gets the data representing the item.
The data representing the item.
Gets or sets the associated with the current item.
Represents the body of a .
The body is the main part of a document presenting visible content,
and can be accessed via the property on the document.
(The only other parts presenting visible document content are page headers and footers.)
Gets the object containing this .
Gets the stacking rules for the current .
Use to set the stacking rules.
Gets a value indicating whether the current contains any render objects
(i.e. whether the collection exists and is not empty).
Gets the collection of elements contained within the current .
Enumerates the fields stored by the class.
No fields.
The title of the document.
The author of the document.
The person who last made changes to the document.
The manager of the author.
The company of the author.
The subject of the document.
The document comments.
The date and time when the document was created.
The date and time when the document was last modified.
The application that created the original document.
The keywords for the document.
The application that created the document.
All fields.
Represents general information about a ,
such as author, subject, creation date and time, and so on.
Can be accessed via the property on a document.
Initializes a new instance of the class.
Indicates whether the current object should be serialized.
true if the current object should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Creates a copy of the current object.
The newly created object.
Returns the collection of the current object
as a single space-delimited string.
Assigns the collection on the current object
from a single string containing the space-delimited list of keywords.
(Note that the collection is cleared by this method prior to assignment.)
The space-delimited list of keywords.
Gets or sets the title of a document.
Gets or sets the author of a document.
Gets or sets the person who last made changes to a document.
Gets or sets the date and time when a document was created.
Gets or sets the date and time when a document was last modified.
Gets or sets the subject of a document.
Gets or sets the application that created a document.
Gets or sets the application that created the original document.
Gets or sets the company of a document's author.
Gets or sets the keywords for a document.
Gets or sets the manager of the author.
Gets or sets the comment.
Gets the of custom user defined string keys and strings associated with a document.
Defines the available unicode ranges.
Alphabetic Presentation Forms.
Arabic Presentation Forms A.
Arabic Presentation Forms B.
Armenian.
Arrows.
Arabic.
Georgian.
Greek.
Hebrew.
Basic Latin.
Bengali.
Block Elements.
Bopomofo, Chinese.
Box Drawing.
Braille.
Canadian Aboriginal Syllabics, Unified.
Cherokee.
Chinese, Japanese, and Korean Symbols and Punctuation.
CJK Compatibility.
CJK Compatibility Forms.
CJK Compatibility Ideographs.
Miscellaneous CJK.
CJK Radicals Supplement.
CJK Unified Ideographs Extension A.
CJK Unified Ideographs.
Combining Diacritical Marks.
Combining Diacritical Marks for Symbols.
Combining Half Marks.
Control Pictures.
Currency Symbols.
Cyrillic.
Devanagari.
Dingbats.
Enclosed Alphanumerics.
Enclosed CJK Letters and Months.
Ethiopic.
Chinese Bopomofo, Extended.
General Punctuation.
Geometric Shapes.
Greek, Extended.
Gujarati.
Gurmukhi.
Halfwidth and Fullwidth Forms.
Hangul, Korean.
Hangul Compatibility Jamo, Korean.
Hangul Jamo, Korean.
Hiragana, Japanese.
Ideographic Description Characters.
IPA Extensions.
KangxiRadicals.
Kannada.
Katakana, Japanese.
Khmer.
Lao.
Latin-1 Supplement.
Latin Extended-A.
Latin Extended Additional.
Latin Extended-B.
Letterlike Symbols.
Malayalam.
Mathematical Operators.
Miscellaneous Symbols.
Miscellaneous Technical.
Mongolian.
Myanmar.
Number Forms.
Ogham.
Optical Character Recognition (OCR).
Oriya.
Private Use Area.
Runic.
Sinhala.
Small Form Variants.
Spacing Modifier Letters.
Specials.
Superscripts and Subscripts.
Surrogates Area.
Syriac.
Tamil.
Telugu.
Thaana.
Thai.
Tibetan.
Yi.
Represents a font embedded in a .
Initializes a new instance of the class.
The to embed.
Adds unique glyphs or glyph ranges from the specified string to the current .
The ranges recognized by this method are represented by the enumeration.
The string to add the glyphs from.
If true, for each unique glyph in , the whole Unicode range containing the glyph
(such as "Basic Latin" or "Cyrillic") is added. If false, only the glyph itself is added.
Adds unique glyphs from the specified string to the current .
The string to add the glyphs from.
Adds a range of glyphs to the current .
The first glyph in the range to add.
The last glyph in the range to add.
Adds all glyphs from the specified range to the current .
The range to add.
Get the object describing the current .
Returns the created FontFamily object.
Gets the name of the current embedded font.
Gets the charset of the current embedded font.
Gets a value indicating whether the current embedded font is bold.
Gets a value indicating whether the current embedded font is italic.
Gets a value indicating whether the license for the current font allows embedding.
Gets a value indicating whether the license for the current font requires obfuscating when embedded.
Gets a value indicating whether the license for the current font allows subsetting when embedded.
Gets a value indicating whether the license for the current font restricts embedding to print and preview uses.
Gets a value indicating whether the current embedded should be obfuscated when embedded.
Gets a value indicating whether the current object has produced the object.
Represents an providing a fast search for the contained elements.
Performs a fast search for the specified object within the current .
The object to search for.
OUT: the index of within the current list, or 0 if the object was not found.
true if was found, false otherwise.
Adds an object implementing the interface to the current list.
The object to add (if the current list already contains this object, an exception is thrown).
The index of the added object in the current list.
Removes the element at the specified index from the current list.
The index of the element to remove.
Removes the specified element from the current list.
The element to remove.
Clears the current .
Returns the index of the specified object in the current .
(Performs a fast search using the method.)
The object to search for.
The index of the specified object within the current list, or -1 if none was found.
Represents a collection of objects.
Adds the specified to the current collection.
Throws an exception if the font is already present in the collection.
The to add.
The index of the newly added font in the collection.
Builds an based on the specified font, and adds it to the current collection.
Throws an exception if the font is already present in the collection.
The to add.
The index of the newly added font in the collection.
Removes the specified font from the current collection.
The to remove.
Returns the index of the specified font in the collection.
The to search for.
The index of in the current collection, or -1 if it was not found.
Searches for a font with the specified name and charset,
which exactly matches the specified bold/italic styles.
The name of the font to search for.
The charset to search for.
The bold style to search for.
The italic style to search for.
The matching , or null if an exact match was not found.
Searches for a font with the specified name and charset,
which is the best match for the specified bold/italic styles
(exact bold/italic matching is not guaranteed by this method).
The name of the font to search for.
The charset to search for.
The style of the font to match.
The matching , or null if a match could not be found.
Builds the Font object from string.
Gets the at the specified index.
The index in the current collection.
The at the specified index.
Represents an that fires events when changing.
Initializes a new instance of the .
Called when the collection is about to be cleared.
Fires the event.
Called after the collection has been cleared.
Fires the event.
Called when an item is about to be iserted.
Fires the event.
The item index.
The item.
Called after an item has been inserted.
Fires the event.
The item index.
The item.
Called when an item is about to be removed.
Fires the event.
The item index.
The item.
Called after an item has been removed.
Fires the event.
The item index.
The item.
Called when an item is about to be set.
Fires the event.
The item index.
The old item.
The new item.
Called after an item has been set.
Fires the event.
The item index.
The old item.
The new item.
Occurs when a change is about to be made to the current collection.
Occurs after a change has been made to the current collection.
Describes the type of a change to a collection.
Item is inserted.
Item is set (changed).
Item is deleted.
Collection is cleared.
Represents the method that will handler an event occuring when
collection changing.
The source of event.
The parameters of event.
Contains data about change events.
Initializes a new instance of the class.
The collection change type.
The old item, or null.
The new item, or null.
The item index, or -1.
Initializes a new instance of the class.
Gets the type of collection's changing.
Gets the old object at specified index.
Gets the new object at specified index.
Gets the index within collection where changing occurs.
Represents an absolute or relative page numbering change in a .
Initializes a new instance of the class.
The page numbering mode.
The page numbering value (semantics depend on ).
Gets the page number changed by the current object.
The current page number.
The page number after the change.
Converts the current object to a string.
The string representing the current object.
Converts a string to a object.
The string to convert.
Indicates whether an exception should be thrown if the specified string cannot be converted.
The created object,
or null if the string could not be converted and is false.
Gets or sets a value determining the page numbering change
represented by the current object.
Gets or sets the absolute page number or increment.
The semantics of this property depend on the value of the property.
Represents a type converter for .
Converts a string to a object.
An that provides a format context.
The string to convert.
The converted value.
Converts an object to a string.
An that provides a format context.
The object to convert.
The converted string.
Defines the stacking rules: block or inline flow,
top to bottom or left to right for block flow.
Objects are placed one beneath another within the container.
When the bottom edge of the current page is reached, a new page is added.
This is the default.
Objects are placed one next to another, from left to right.
When the right edge of the current page is reached, a new horizontal page is added
(a horizontal page logically extends the preceding page to the right;
C1PreviewPane respects this location by default, showing such pages in a row).
Objects are placed inline, one next to another, from left to right.
When the right edge of the current page is reached, the sequence wraps to the next line.
A new page is added when the bottom of the current page is reached.
Defines the device (printer or screen) used to measure the elements of a .
Use printer device to measure document elements.
Use system screen device to measure document elements.
Defines the generation mode of a .
The document was not generated, its creation mode is unknown at this time.
The document was created by a call to the method.
The document was created by calls to the and
methods.
Describes the type of a page numbering change in a .
Set the page number to a specified absolute value.
Increment the current page number by a specified value.
Describes the busy state of a .
The document is not busy.
The document is currently generating.
The document is currently saving.
The document is currently loading.
For internal use only.
Provides graphics-related static helper methods and properties.
Reads a from a byte array.
The byte array containing the data.
The newly created .
Writes a to a byte array.
The to write.
The byte array containing the data.
Serializes a to a .
The to serialize.
The target .
Serializes a to a disk file.
The to serialize.
The target file name.
Saves an to a .
The to save.
The to use for saving the image
(ignored if the image is a ).
The object containing image data, or null if an error occurred while saving.
Unlike the standard method,
this method saves objects as metafiles, without any conversions
(the standard method converts metafiles to PNG format prior to saving).
Saves an to a .
The to save.
The to use for saving the image
(ignored if is a , and is true).
If true, metafiles are saved without conversion, ignoring .
Otherwise, the image is saved in the specified format.
The object containing image data, or null if an error occurred while saving.
Unlike the standard method,
this method is able to save objects as metafiles, without any conversions
(the standard method converts metafiles to PNG format prior to saving even if such conversion is not requested).
Saves an to a array of bytes.
The to save.
The to use for saving the image
(ignored if is a , and is true).
If true, metafiles are saved without conversion, ignoring .
Otherwise, the image is saved in the specified format.
The object containing image data, or null if an error occurred while saving.
Unlike the standard method,
this method is able to save objects as metafiles, without any conversions
(the standard method converts metafiles to PNG format prior to saving even if such conversion is not requested).
Creates an image from a byte array.
The byte array containing the image data.
The object or null if the image could not be created.
Returns for the specified image format,
or null.
The image format (e.g. as returned by ).
The corresponding or null if none was found.
Returns the logical and physical screen resolution.
OUT: the logical horizontal resolution.
OUT: the logical vertical resolution.
OUT: the physical horizontal resolution.
OUT: the physical vertical resolution.
Returns the horizontal resolution of the specified device context.
Handle of the device context.
Returns the vertical resolution of the specified device context.
Handle of the device context.
Creates an instance of and fills it with data about the specified metafile.
The to get information about.
OUT: containing information about .
Gets the size of a metafile.
The metafile to get the size of.
The target unit of measurement.
The target horizontal resolution (used if is ).
The target vertical resolution (used if is ).
The size of in units specified by .
Gets the size of an image.
The image to get the size of.
The target unit of measurement.
The target horizontal resolution (used if is ).
The target vertical resolution (used if is ).
The size of in units specified by .
Gets the resolution of an image.
If the image is a containing a ,
resolution is taken from that info.
The image.
The image resolution (DPI).
Draws the specified .
to draw on.
The to draw.
The alignment rectangle.
The clipping rectangle, can be null in this case clipping not applied.
The image alignment (if null, is used).
An object implementing the ,
Uses Graphics.DrawImage(image, dstRect) method instead of Graphics.DrawImage(image, dstRect, srcRect, GraphicsUnit) in some rare cases this method (with 2 parameters) produces better results.
if not null, and is a , used to draw the image.
Converts a metafile from or
to
The to convert.
The to use in converting,
if null, the screen DC is used.
The converted metafile.
Creates a representing a rounded rectangle.
The rectangle to base the result on.
The size of the ellipse used to draw rounded corners.
The representing rounded using .
Creates a representing a rounded rectangle.
The rectangle to base the result on.
The size of the ellipse used to draw rounded corners.
The representing rounded using .
Draws a rounded rectangle on the specified with the specified .
The to draw on.
The to draw with.
The to use as the base for the rounded rectangle.
The size of the ellipse used to draw rounded corners.
Fills a rounded rectangle on the specified with the specified .
The to draw on.
The fill to use.
The to use as the base for the rounded rectangle.
The size of the ellipse used to draw rounded corners.
Draws a rounded rectangle on the specified with the specified .
The to draw on.
The to draw with.
The to use as the base for the rounded rectangle.
The size of the ellipse used to draw rounded corners.
Fills a rounded rectangle on the specified with the specified .
The to draw on.
The fill to use.
The to use as the base for the rounded rectangle.
The size of the ellipse used to draw rounded corners.
Compares two images by content.
The first to compare.
The second to compare.
true if the images have the same content, false otherwise.
Compares two images by content, optionally using fuzzy comparison.
The first to compare.
The second to compare.
true to use fuzzy comparison (ignoring minor differences),
false to use strict comparison.
true if the images have the same content, false otherwise.
Tests whether the content of an image is equal to the content of a 's
.
This method performs fuzzy comparison (see ).
The image to compare.
The to compare.
true if the images are equal, false otherwise.
Calculates bytes per pixel based on .
The to test.
Bytes per pixel.
Compares the content of two bitmaps.
The first bitmap to compare.
The second bitmap to compare.
true if bitmaps have the same content, false otherwise.
Compares the content of two bitmaps,
optionally performing fuzzy comparison.
The first bitmap to compare.
The second bitmap to compare.
true to use fuzzy comparison, false otherwise.
true if bitmaps have the same content, false otherwise.
Gets the physical horizontal resolution of the screen.
Gets the physical vertical resolution of the screen.
Gets the logical horizontal resolution of the screen.
Gets the logical vertical resolution of the screen.
Represents a GDI device context.
Initializes a new instance of the class.
The GDI DC to use.
Indicates whether to save clip region.
Initializes a new instance of the class.
The graphics to use.
Indicates whether to save clip region.
Destructs this instance.
Disposes this instance.
Returns the clipping region.
Handle to the clipping region.
Sets the clipping region.
The clipping region.
The mode to use.
Sets the clipping region.
Sets the clipping region.
Sets the clipping region.
Sets the clipping region.
Sets the clipping region.
Sets the clipping region.
Draws frame rectangle.
Fills a rectangle.
Draws a focus rectangle.
Draws a text.
Draws a disabled text.
Draws a line.
Draws a rectangle.
Draws a frame rectangle.
Fills a rectangle.
Draws a checkmark.
Draws an ellipse.
Gets the DC.
Gets horizontal DPI.
Gets vertical DPI.
Indicates text alignment.
Near alignment.
Center alignment.
Far alignment.
Holds a Graphics object together with (printer) device or bitmap that was used
to create it, if any. The point is to dispose the device or bitmap together
with the graphics when it is no longer needed (i.e. to avoid resource leaks).
An empty graphics holder instance.
Creates a graphics holder from a device context.
When the holder is disposed, both graphics and the device context are released (DeleteDC is called on the device context).
The device context from which graphics is created.
The new instance of the graphics holder.
Creates a graphics holder from a graphics instance.
When the holder is disposed, the graphics is left alone (i.e. NOT disposed).
The graphics to store in the new holder.
The new instance of the graphics holder.
Creates a graphics holder from screen. If that fails (e.g. on Azure), the graphics is created from a bitmap.
When the holder is disposed, both graphics and the bitmap are released.
The new instance of the graphics holder.
Creates a graphics holder from a bitmap. The graphics and the bitmap are released when the holder is disposed.
This should never fail.
The new instance of the graphics holder.
Disposes the current graphics holder.
Gets the graphics object held by the current instance.
Gets the horizontal resolution of graphics held by the current instance.
Gets the vertical resolution of graphics held by the current instance.
If an object implements this interface, it can be seamlessly rendered
in a via a .
Gets the content of control as Image.
The Image object representing a control content.
Gets the content of control as C1 document
that is serialized in stream.
This document can be built with using C1PrintDocumentClient.
The stream object containing the document tree.
Describes the direction in which the new page should be started.
Type of page (vertical or horizontal)
is determinated on the basis of the current stacking rules.
Vertical page is added if Stacking is StackingRulesEnum.BlockTopToBottom.
Vertical page direction - i.e. logically the next page is below the current one.
Horizontal page direction - i.e. logically the next page is to the right of the current one.
The base type for classes describing layout-releated
changes that are applied to a before or after a
if assigned to or
on that object.
Derived classes include
,
,
and
.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Creates a copy of the current object.
The newly created object.
Describes layout-related changes associated with a .
When an instance of this class is assigned to
or on that object,
a page break is inserted before of after that object,
and layout changes described by the instance are applied to the new page.
Initializes a new instance of the class.
Initializes a new instance of the class.
The to assign to the property of the current instance.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or set the to apply to the new page.
Gets or sets the of the new page.
Gets or sets a value indicating whether the currently active page layout
should be saved in a stack before applying this ,
to be restored after the associated has been fully rendered.
Describes layout-related changes associated with a .
When an instance of this class is assigned to
or on that object,
a column break is inserted before of after that object,
and layout changes described by the instance are applied.
Describes layout-related changes associated with a .
When an instance of this class is assigned to
or on that object,
and the current is ,
a line break is inserted before of after that object,
and layout changes described by the instance are applied.
Describes layout-related changes associated with a .
When an instance of this class is assigned to
or on that object,
layout changes described by the instance are applied
to the next new page (but no immediate page break is caused by this class).
Initializes a new instance of the class.
Initializes a new instance of the class.
The to assign to the property of the current instance.
Assigns (copies) properties from another to the current object.
Gets or set the to apply to the next page.
Describes arguments for the event fired periodically by a potentially
long operation. Allows to provide feedback to the user and may also
allow to cancel the operation.
Creates a new instance of LongOperationEventArgs with default
properties (Complete=0, CanCancel=false).
Creates a new instance of LongOperationEventArgs with the
specified complete value and CanCancel=false.
How much is complete (from 0 to 1).
Creates a new instance of LongOperationEventArgs with the
specified complete and CanCancel values.
How much is complete (from 0 to 1).
Whether the operation can be cancelled.
Creates a new instance of LongOperationEventArgs with the
specified CanCancel value and Complete=0.
Whether the operation can be cancelled.
Gets the approximate completed ratio, from 0 (0% complete) to 1 (100% complete).
Gets the value indicating whether the event handler can cancel the current long operation
by setting the property to true.
Gets or sets a value indicating whether the current long operation
should be cancelled. (This property is ignored if is false.)
Represents a method that can handle a long operation event.
The source of the event.
A that contains event data.
For internal use.
For internal use.
Represents an outline node within a .
Initializes a new instance of the class.
Initializes a new instance of the class.
The node caption.
Initializes a new instance of the class.
The node caption.
The location within a document associated with the current node.
Initializes a new instance of the class.
The node caption.
The associated with this node.
Initializes a new instance of the class.
The node caption.
The location within a document associated with the current node.
The icon associated with the current node.
Creates a copy of the current .
This method NOT copies Children property.
The newly created object.
Determines the target of the current hyperlink.
The hyperlink target is described by an instance of a class derived from ,
and can be of one of the following types:
-
An anchor defined within the current document.
-
A location within the current document.
-
An anchor defined within a previously saved C1D document.
-
An external document, program or URL. The ShellExecute API is used to invoke the link.
-
A page within the current document.
-
The hyperlink target is determined by a user event handler.
Gets the containing the current node.
Gets the which is the parent of the current node.
Gets the nesting level of the current node within the nodes' tree
(top-level nodes have level 0).
Gets or sets the associated with the current node.
Gets or sets the UI string used to represent the current node.
Gets or sets the icon used to represent the current node.
Gets or sets the name in the of the icon used to represent the current node.
Gets the collection of child nodes of the current node.
Note that accessing this property initializes the collection if it has not been initialized yet.
To test whether there are child nodes without this side effect, use the property.
Gets a value indicating whether the collection of the current node
has been initialized and contains at least one element.
Gets the that is the root of the current node tree.
Gets the containing the current node tree.
Represents a collection of elements.
Gets the type of elements in this collection.
The type.
Adds a node to the current collection.
The node to add.
The index of the newly added node in the current collection.
Adds a node with the specified caption and location to the current collection.
The caption of the node to add.
The index of the newly added node in the current collection.
Adds a node with the specified caption and location to the current collection.
The caption of the node to add.
The location associated with the node.
The index of the newly added node in the current collection.
Adds a node with the specified caption and link target to the current collection.
The caption of the node to add.
The associated with the node.
The index of the newly added node in the current collection.
Adds a node with the specified caption, location and icon to the current collection.
The caption of the node to add.
The location associated with the node.
The icon associated with the node.
The index of the newly added node in the current collection.
Removes a node from the current collection.
The node to remove.
Gets or sets the element at the specified index.
The index in the current collection.
The element at the specified index.
Represents the properties of a page column.
Initializes a new instance of the class.
Initializes a new instance of the class.
A string that is converted to a value representing the of the current column.
A string that is converted to a value representing the of the current column.
Initializes a new instance of the class.
A value representing the of the current column.
A a value representing the of the current column.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Creates a copy of the current object.
The newly created object.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Compares the properties on the current object to another .
The to compare the current object with.
true if the properties of the two objects are equal, false otherwise.
Gets or sets the width of the current column.
The default column width is "auto".
Gets or sets the spacing between the current and next columns.
The default column spacing is 5mm.
Represents a type converter for .
Tests whether the current converter can convert this object to the specified type.
The converter context.
The target type.
true if the object can be converted, false otherwise.
Converts the object to the specified type.
The converter context.
The culture.
The value to convert.
The target type.
The converted object.
Represents a collection of objects.
Adds a to the current collection.
The to add.
The index of the added in the current collection.
Adds a new initialized with the specified width and spacing to the current collection.
The of the new column definition.
The of the new column definition.
The index of the added in the current collection.
Adds a new initialized with the
default and to the current collection.
The index of the added in the current collection.
Inserts a into the current collection.
The index at which to insert the specified .
The column definition to insert.
Removes a from the current collection.
The column definition to remove.
Returns the index of the specified in the current collection.
The to search for.
The index of the specified column definition in the current collection.
Compares the current collection to another.
Uses the to compare elements
elements at the corresponding positions by their properties' values.
The to compare the current with.
true if the two collections have the same elements at the same positions, false otherwise.
Gets or sets the element at the specified index.
The index in the current collection.
The element at the specified index.
Identifies the set of pages to which a page layout is applied in a .
The current page layout is not a member of any document's PageLayouts collection.
The current page layout is the default for a document.
The current page layout is to be used for the first page of a document.
The current page layout is to be used for the last page of a document.
The current page layout is to be used for even pages of a document.
The current page layout is to be used for odd pages of a document.
Represents the page layout of a .
Initializes a new instance of the class.
Initializes a new instance of the class.
The page settings to use.
Initializes a new instance of the class.
The page settings to use for the current page layout.
The column defitions to use for the current page layout.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Creates a copy of the current object.
All nested objects (render objects, page settings etc.) are cloned on the new object.
The newly created object.
Assigns (copies) properties from another to the current object.
All nested objects (render objects, page settings etc.) are cloned.
The source object to copy properties from.
Clears the current object.
Gets the containing the current object.
Gets the associated with the current
in the document.
If is null, is returned.
Gets or sets the object associated with the current page layout.
Gets or sets the page header associated with the current page layout.
Gets or sets the page footer associated with the current page layout.
Gets or sets the watermark associated with the current page layout.
Gets or sets the overlay associated with the current page layout.
Gets or sets a value indicating whether the collection
on the current page layout has been initialized and is not empty.
Gets the collection of objects associated with the current page layout.
Note that accessing this property initializes the collection of column definitions
if it has not been initialized yet.
Use to test whether any columns have been defined on this layout.
Represents the standard page layouts used in a
(such as the default page layout, page layout used for first and last pages,
and so on).
Initializes a new instance of the class.
The that is the owner of the current instance.
Clears the current object.
Gets the object that owns the current object.
Gets the of the specified .
Returns null if the specified kind of page layout has not been specified
for the current .
The kind of page layout to return.
The page layout with specified kind, or null if it does not exist.
Gets or sets the used for the first page of the current document.
Gets or sets the used for the last page of the current document.
Gets or sets the used for even pages of the current document.
Gets or sets the used for odd pages of the current document.
Gets or sets the default for the current document.
The effective page layout for each page is determined by merging this layout
with all other applicable layouts.
The effective layout can be accessed via the property
on the .
Gets or sets a value indicating whether the page header should
print on the first page of the document.
This property overrides other related properties when set to false.
The default value is true.
Gets or sets a value indicating whether the page footer should
print on the first page of the document.
This property overrides other related properties when set to false.
The default value is true.
Gets or sets a value indicating whether the page header should
print on the last page of the document.
This property overrides other related properties when set to false.
The default value is true.
Gets or sets a value indicating whether the page footer should
print on the last page of the document.
This property overrides other related properties when set to false.
The default value is true.
Gets or sets a value indicating whether to suppress adding an empty page
at the end of the document if the last object contains a page break after itself.
The default value is false.
For internal use only.
A static class providing printer-related utilities.
Creates the information context for specified printer.
That context can be used for measurement operations, but must NOT be used for drawing.
The printer name.
The context handle, or IntPtr.Zero if an error occurs.
Gets the resolution of the specified printer.
The printer name.
A structure where
represents the horizontal, and vertical DPI.
is returned if an error occurs.
Gets the resolution for the specified device context.
The device context to test.
A structure where
represents the horizontal, and vertical DPI.
is returned if an error occurs.
Tests whether the specified printer name is valid.
The printer name.
true if the specified printer name is valid, false otherwise.
Searches for a printer with the specified minimal resolution,
and the same horizontal and vertical resolutions.
The minimum acceptable DPI.
If this parameter is 0, the first available printer with the same horizontal and vertical resolutions is returned.
OUT: The resolution of the found printer, or 0 if a printer was not found.
The name of the found printer, or null if a printer was not found.
Searches for a printer with the specified minimal resolution,
and the same horizontal and vertical resolutions.
The minimum acceptable DPI.
If this parameter is 0, the first available printer with the same horizontal and vertical resolutions is returned.
The name of the found printer, or null if a printer was not found.
For internal use only.
Represents a hashtable of properties and their values.
Clears the current instance.
Gets the index of a property in the and arrays.
The property key.
The 0-based index of the specified property in the and arrays.
Sets the value of a property.
The property key.
The property value to set.
Deletes a property value from the current .
The property key to remove.
Gets a value indicating whether the current is empty.
Tests whether a property is set in the current .
The property key.
true if the specified property has been set on the current , false otherwise.
Gets the number of properties set on the current .
This value is equal to the number of elements in the and collections.
Gets the array of property keys set in the current .
Gets the array of property values set on the current .
Represents a general-purpose container for other objects.
The abstract base class for all render objects representing content of a .
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
Initializes a new instance of the class.
Tests whether the property should be serialized.
True if the property should be serialized, false otherwise.
Tests whether the Flags property should be serialized.
True if the property should be serialized, false otherwise.
Tests whether the property should be serialized.
True if the property should be serialized, false otherwise.
Tests whether the property should be serialized.
True if the property should be serialized, false otherwise.
Tests whether the property should be serialized.
True if the property should be serialized, false otherwise.
Tests whether the property should be serialized.
True if the property should be serialized, false otherwise.
Tests whether the property should be serialized.
True if the property should be serialized, false otherwise.
Tests whether the property should be serialized.
True if the property should be serialized, false otherwise.
Tests whether the property should be serialized.
True if the property should be serialized, false otherwise.
Tests whether the property should be serialized.
True if the property should be serialized, false otherwise.
Tests whether the property should be serialized.
True if the property should be serialized, false otherwise.
Performs some initializations.
Gets the default value for the property.
True.
Gets the default value for the property.
.
Gets the default value for the property.
.
Gets the default value for the Flags property.
0.
Gets the default value for the property.
SplitBehaviorEnum.Never
Gets the default value for the property.
SplitBehaviorEnum.Never
Returns the value of flag. The object has private field:
private int _flags;
This field can be used for storing various boolean properties
(CanSplitHorz, CanSplitVert etc), for example CanSplitHorz property defined as:
public bool CanSplitHorz
{
get { return GetFlag(c_flgCanSplitVert); }
set { SetFlag(c_flgCanSplitVert, value); }
}
Mask of flag.
Returns true if specified flag is set.
Sets value of flag.
Mask of flag.
Value of flag.
Called after adding new child RenderObject object to the Children collection.
User can throw exception if this object can't be added as the child for this object.
Child RenderObject object.
Called after removing child RenderObject object from the Children collection.
User can throw exception if this object can't be removed.
Child RenderObject object.
Called after adding this object to the Children collection
of another object.
User can throw exception if this object can't be added as the child for this object.
The new parent object for this object.
Called after removing this object from the Children collection
of another object.
The parent object of this object.
Override this method to perform additional actions when value of the Width property of object is being read.
Override this method to perform additional actions when value of the Width property of object is being defined.
Override this method to perform additional actions when value of the Height property of object is being read.
Override this method to perform additional actions when value of the Height property of object is being defined.
Override this method to perform additional actions when value of the SplitVertBehavior property of object is being defined.
Override this method to perform additional actions when value of the SplitHorzBehavior property of object is being defined.
Gets the value of a child's ambient style property.
The child .
The style property key.
to use for evaluation of calculated properties.
The style property value.
Gets the value of a child's non-ambient style property.
The child .
The style property key.
to use for evaluation of calculated properties.
The style property value.
Override this method and return false if you want manually copy of children
objects for this object. This method returns true by default.
Boolean value indicating that the children objects must be copied in the AssignFrom method.
Assigns (copies) properties from another to the current object.
The list of fragments (the property) is neither copied nor changed.
Properties , are copied by reference.
The property is not copied.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Assigns (copies) properties from another to the current object.
The list of fragments (the property) is neither copied nor changed.
Properties , are copied by reference.
The property is not copied.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Assigns (copies) properties from another to the current object.
The list of fragments (the property) is neither copied nor changed.
Properties , are copied by reference.
The property is not copied.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Assigns (copies) properties from another to the current object.
The list of fragments (the property) is neither copied nor changed.
Properties , are copied by reference.
The property is not copied.
The source object to copy properties from.
Clones the current .
Indicates whether the property should be cloned.
Indicates whether the property should be cloned.
The newly created object.
Clones the current .
Indicates whether the property should be cloned.
Indicates whether the property should be cloned.
Indicates whether the property should be cloned.
Indicates whether the property should be cloned.
Indicates whether the property should be cloned.
Indicates whether the property should be cloned.
The newly created object.
Clones the current .
Indicates whether the property should be cloned.
Indicates whether the property should be cloned.
Indicates whether the property should be cloned.
Indicates whether the property should be cloned.
The newly created object.
Clones the current .
The newly created object.
Calculates the number of objects which are owned by the current object.
This method takes into account:
-
Child objects and their children;
-
Objects which are specified in page layouts (such as PageHeader, PageFooter etc.).
The number of owned objects.
Calculates the count of objects which are nested within this object.
This method takes into account child objects and their children.
Returns the count of nested objects.
Returns a human-readable textual description of the location of the current object in the document.
Returns the approximate count of fragments in the current object
(used to show progress during document generation).
Clears temporary information created during document resolving.
Override this method to clear render object type-specific data
(but call the base method to clear common data).
This method is called once for each object,
override it to perform custom initialization.
For internal use only.
This method is called once after the current has been fully resolved.
At the time of the call all objects a built and placed on their pages.
Override it to perform custom processing at that time.
Resolves the values of calculated fields of object.
Resolves the calculated values of object's style.
Clears the values of calculated properties, called when a document is regenerated.
Indicates that values depending on data fields should also be cleared.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Internal use only.
Indicates whether to automatically process data binding on child objects.
The default implementation returns true,
override it and return false if custom child data binding processing
is required.
true.
Returns the object for a specified child object.
The object that is a child of the current object.
The object for the specified child object,
or null if data binding is not specified for that child.
For internal use only.
Resolves calculated properties of the object.
object properties of that should be resolved.
object for calculated properties.
and can be the same.
Returns the index of the specified of the current object
in the collection.
The to return the index of.
The 0-based index of the specified fragment in ,
or -1 if there are no fragments or the fragment was not found.
Calculates the size of the current object.
When this method is called, the object must already have been added to the document
(e.g. to or to
of another object in the document).
See remarks for more details.
The width of the current object.
This parameter may be specified as or as an absolute value (but it must not reference other objects).
The height of the current object.
This parameter may be specified as or as an absolute value (but it must not reference other objects).
The size of the current object, in units.
If the current object has not been added to the document, an exception is thrown.
(This is because to calculate the size of an object, its style is needed, and
due to style inheritance, the effective style of an object depends on the placement
of that object within the document.)
The object may be removed from the document after calling this method if desired.
The following C# code may be used to test whether a will fit
on the current page if inserted at the current block flow position
(see ):
C1PrintDocument doc = new C1PrintDocument();
doc.StartDoc();
RenderText rt = new RenderText("The text to measure.);
// add the object temporarily to calculate its size:
doc.Body.Children.Add(rt);
// measure the object, specifying page width and auto heigh
// (i.e. effectively, measure the text height):
C1PageSettings ps = doc.PageLayout.PageSettings;
double pageWidth = ps.Width.Value - ps.LeftMargin.Value - ps.RightMargin.Value;
SizeD sz = rt.CalcSize(new Unit(pageWidth, ps.Width.Units), Unit.Auto);
// remove the object added temporarily:
doc.Body.Children.Remove(rt);
// test whether the object would fit on the page:
if (doc.AvailableBlockFlowHeight >= sz.Height)
{
// object would fit, do something:
doc.RenderBlockText("YES");
}
doc.EndDoc();
Gets or sets a value indicating how borders are drawn
if the object is too high and is split between pages.
Gets or sets a value indicating how borders are drawn
if the object is too wide and is split between horizontal pages.
Gets the most nested containing the current render object,
or null if the current object is not contained in a table.
Gets the 0-based index of the row in the most nested
containing the current render object, or -1 if the current object
is not contained in a table.
Gets the 0-based index of the column in the most nested
containing the current render object, or -1 if the current object
is not contained in a table.
Gets or sets the value indicating whether the object should be clipped.
Gets the object containing the current .
Gets the containing the current object,
or null if the current object has no or the owner is not a .
Gets the index of the current object within the , or -1 if there is no owner.
Gets the parent containing the current object.
Gets or sets the name of the current object.
The name can be an empty string. If it is not empty, the name must be unique
among the current object's siblings (i.e. objects with the same ).
Gets or sets arbitrary data associated with the current object.
Gets a value indicating whether the current object has children
(i.e. its collection contains at least one element).
Gets the collection of child render objects.
Gets or sets the stacking rules used to arrange the children of the current object.
For block flow, the alignment of child objects within the flow is determined by the
value of property on the current object,
and the values of properties on the children.
Gets or sets the value determining how the object is treated
when it is too high to fit in the vertical space available on the current page.
Gets or sets the value determining how the object is treated
when it is too wide to fit in the horizontal space available on the current page.
Indicates whether the object can be split horizontally if it falls on a page break.
Indicates whether the object can be split vertically if it falls on a page break.
Gets or sets the Z-order of the current object.
Objects with smaller Z-order values are drawn under objects with larger Z-order values.
By default, this property is zero.
Gets or sets the X coordinate of the current object.
May be specified as auto (),
an absolute value (using ),
an absolute value with unit of measurement (e.g. "12mm"),
or an expression referencing this and other objects (e.g. "prev.right+2mm").
Gets or sets the Y coordinate of the current object.
May be specified as auto (),
an absolute value (using ),
an absolute value with unit of measurement (e.g. "12mm"),
or an expression referencing this and other objects (e.g. "prev.height/2-self.height/2").
Gets or sets the width of the current object.
May be specified as auto (),
a percentage of the parent's width (e.g. "50%"),
an absolute value (using ),
an absolute value with unit of measurement (e.g. "12mm"),
or an expression referencing this and other objects (e.g. "Max(prev.width,6cm)").
Gets or sets the height of the current object.
May be specified as auto (),
a percentage of the parent's height (e.g. "50%"),
an absolute value (using ),
an absolute value with unit of measurement (e.g. "12mm"),
or an expression referencing this and other objects (e.g. "150%prev.height+1in").
Gets or sets the type of break (none, line, column, or page) to insert before the current object.
Gets or sets the type of break (none, line, column, or page) to insert after the current object.
Gets or sets the object
defining the change of page layout that will occur before the current object.
is an abstract class.
Instances of the following non-abstract classes derived from it can be assigned to this property:
- Does not insert a break. Provides the ability to change page layout for the next page without interrupting the current flow.
- Inserts a line break in the inline flow. Does not break the block flow.
- Starts a new column in a multi-column layout, or a new page otherwise.
- Starts a new page.
Gets or sets the object
defining the change of page layout that will occur after the current object.
is an abstract class.
Instances of the following non-abstract classes derived from it can be assigned to this property:
- Does not insert a break. Provides the ability to change page layout for the next page without interrupting the current flow.
- Inserts a line break in the inline flow. Does not break the block flow.
- Starts a new column in a multi-column layout, or a new page otherwise.
- Starts a new page.
Gets the of the current object.
This property cannot be assigned to. To use another style as the base
for the current object's style, set the to that other style.
Gets or sets the object
defining the page numbering change that will occur when the current object is rendered.
Gets or sets the hyperlink (see ) associated with the current object.
Gets the collection of anchors (elements of the type ) associated with the current object.
Gets a value indicating whether the current object has any anchors associated with it
(i.e. whether the collection exists and is not empty).
Gets the object containing the current object,
or null if the current object is not contained in a cell of a .
Gets or sets a render object which should be printed on the same page
as the current object. The specified object must have the same
as the current object.
Gets or sets a value indicating the visibility of the current object.
Gets or sets the script that is executed when the current object has been completely resolved,
all its fragments created and added to the collection
of the current object.
This script may be used to adjust the look of an object after resolving,
for instance the background of the object may be set depending on whether
the object has been split between pages (i.e. the
collection contains more than 1 element). The following code sets the
background of a to red if it has been split
between pages, and to green if it has not been split:
C1PrintDocument doc = new C1PrintDocument();
RenderArea ra = new RenderArea();
ra.ObjectResolvedScript = "if RenderObject.Fragments.Count > 1 then\r\n" +
"RenderObject.Style.BackColor = Color.Red\r\n" +
"else\r\n" +
"RenderObject.Style.BackColor = Color.Green\r\n" +
"end if\r\n";
ra.Style.Borders.All = LineDef.DefaultBold;
// ... fill ra with sample content:
for (int i = 0; i < 30; i++)
ra.Children.Add(new RenderText("Line " + i.ToString()));
doc.Body.Children.Add(ra);
Note that while you can adjust any style properties on the object,
the size and position of the object will not be re-calculated even
if a property affecting it (such as font size) changes (so, for instance,
if the font size is increased, clipping may occur). Basically,
this means that normally only properties that do not affect the
object's layout (such as text and background colors) should be changed
in this script.
Gets or sets the script that is executed each time a
of the current render object is created and added to the collection
on the current object.
Gets a value indicating whether the current object's
collection has been initialized and contains one or more fragments.
Gets a containing the fragments
produced by the current object in the generated document.
This property always returns a non-null fragments collection,
initializing it if it has not been initialized yet.
Use to test whether there are any fragments
without initializing .
Gets the first fragment of the current object,
or null if has not been initialized yet.
Gets the last fragment of the current object,
or null if has not been initialized yet.
Gets an instance of class representing the
data binding properties of the current object.
This property always returns a object,
initializing it if if has not been initialized yet.
Use to test whether the current object
is data bound without initializing .
Gets a combination of flags
specifying the data binding mode of the current object.
Gets a value indicating whether the current object is data bound.
Returns true if the object's property
has been initialized and its is not .
Gets the collection of objects generated by data binding.
The value of this property is null if the object is not data bound.
Gets the original object that produced the current object
during data binding, or null if there is no such object.
Gets or sets a script that is executed each time a new instance
of the current
is created due to data binding resolving.
Initializes a new instance of the class.
Gets the default value for the Flags property.
Default flags plus CanSplitHorz and CanSplitVert.
Gets the default horizontal split behavior (area is too wide).
.
Gets the default vertical split behavior (area is too high).
.
Gets the default area width.
Parent width.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Gets or sets a that is repeated on all pages (or columns)
if the current render area is split vertically when it is too high to fit on
a single page.
The specified render object should not be a child of another render object.
It can be a child of the current render area; if it is not, it will be
added to the current render area's collection.
Gets or sets a that will be repeated on all "horizontal" pages
if the current render area is split horizontally when it is too wide to fit on
a single page.
The specified render object should not be a child of another render object.
It can be a child of the current render area; if it is not, it will be
added to the current render area's collection.
Represents an empty .
Provides a convenient placeholder for things like page breaks and so on,
where no content needs to be rendered.
Initializes a new instance of the class.
Initializes a new instance of the class
with specified width and height.
The width of the current object.
The height of the current object.
Initializes a new instance of the class
with a specified height.
The height of the current object.
Initializes a new instance of the class
with a zero height and a specified value.
They type of break that is to be inserted after this object.
Gets the default value for the property.
.
Gets the default value for the property.
.
Represents a drawing on a .NET object
in a .
Initializes a new instance of the class.
Indicates whether the content of the current object
should be serialized (i.e. is not empty).
For internal use.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Clears the current object.
Gets or sets value indicating whether Graphics.DrawImage(Image, dstRect)
method should be used to draw content of object instead of
Graphics.DrawImage(Image, dstRect, srcRect, GraphicsUnit). In some rare cases
it produces more convient results. Default is false.
Set this value to true if problems occurs with drawing RenderGraphics content.
Gets or sets the type of metafile created by the current object.
Gets the object to draw on.
Gets the reference used to create the underlying metafile.
This property is simply a shortcut to the property,
and returns null if the current object has not been added
to a yet.
Represents an image in a .
Can also be used to show an image of a System.Windows.Forms.Control.
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the property.
An that is assigned to the property.
Initializes a new instance of the class,
assigning the property.
A string that is assigned to the property.
Initializes a new instance of the class,
assigning the property,
and specifying a to use.
An that is assigned to the property.
A to use
(the method
is used to copy the specified style to the current object's ).
Initializes a new instance of the class,
assigning the property,
and specifying a to use.
A string that is assigned to the property.
A to use
(the method
is used to copy the specified style to the current object's ).
Initializes a new instance of the class,
assigning the property,
and specifying a to use.
An that is assigned to the property.
An that is assigned to
of the current object's .
Initializes a new instance of the class,
assigning the property,
and specifying a to use.
A string that is assigned to the property.
An that is assigned to
of the current object's .
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Gets or sets value indicating whether Graphics.DrawImage(Image, dstRect)
method should be used to draw content of object instead of
Graphics.DrawImage(Image, dstRect, srcRect, GraphicsUnit). In some rare cases
it produces more convient results. Default is false.
Gets or sets an that is
rendered by the current object.
Gets or sets the name of an image that is
rendered by the current object.
When the current object renders, the actual image is retrieved by this name
from the of the containing .
Gets or sets a object,
an image of which is rendered by the current object.
The property on the
of the current RenderImage object determines whether the whole control, or just its client area,
is rendered.
Note that this property does not cause the current object to render a real live control
that can be used for user input, only a visual image representing the specified control.
For real control behavior, see and derived classes.
Represents a single occurrence of an in the document.
Elements of this type are contained in the collection
of an .
The main functional property of this class is ,
of the type , which points to the location of the occurrence
in the document.
Initializes a new instance of the class.
The that is assigned to the property of the current occurrence.
Initializes a new instance of the class.
The that is assigned to the property of the current occurrence.
The bold flag that is assigned to the property of the current occurrence.
The italic flag that is assigned to the property of the current occurrence.
Creates a copy of the current object.
The newly created object.
Gets or sets the that is associated with the current occurrence.
Gets or sets a Boolean value allowing to highlight the page number
corresponding to a certain occurrence of an entry using bold face.
(Can be used to highlight the location where the main definition
of an index entry is provided, for example.)
Gets or sets a Boolean value allowing to highlight the page number
corresponding to a certain occurrence of an entry using italic face.
(Can be used to highlight the location where the main definition
of an index entry is provided, for example.)
Represents an entry in a word index of a .
Top-level entries of a (represented by instances of this class)
are contained in the collection on the index object.
Nested entries are contained in the parent entry's
The current entry's occurrences in the document are represented by instances
of the class, and are contained in the
collection of the entry.
Initializes a new instance of the class.
Initializes a new instance of the class.
The string that is assigned to the property of the current index entry.
Initializes a new instance of the class.
The string that is assigned to the property of the current index entry.
One or more objects that are added to the collection of this index entry.
Initializes a new instance of the class.
The string that is assigned to the property of the current index entry.
A list of objects; for each target in that list,
a is created and added to the of the current index item.
Creates a copy of the current object.
The newly created object.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets the string that will represent the current index entry in the generated index.
Gets the of objects
representing occurrences of the current index entry in the document.
In the generated index, each occurrence is replaced by the page number,
which is a hyperlink to the occurrence's location in the document.
(Consecutive page numbers are collapsed to ranges.)
This method always returns a non-null,
creating it if it did not exist.
To test whether an index entry already contains occurrences
without creating the collection,
use the property.
Gets a value indicating whether the collection
has been created and contains one or more elements.
Gets the containing the nested index entries,
i.e. sub-entries of the current index entry.
This method always returns a non-null,
creating it if it did not exist.
To test whether an index entry already contains any sub-entries
without creating the collection,
use the property.
Gets a value indicating whether the collection
has been created and contains one or more elements.
Gets the of objects
related to the current index entry.
In the generated index, those entries will be listed as "See also"
cross-references from the current to other entries.
This method always returns a non-null,
creating it if it did not exist.
To test whether an index entry already contains any "See also" references
without creating the collection,
use the property.
Gets a value indicating whether the collection
has been created and contains one or more elements.
Gets the for the current index entry.
Gets the for the current index entry's
"See also" references (see ).
Gets the level of the current index entry.
The top-level entries' level is 0, sub-entries' level is 1, and so on.
If the current index entry has not been added to a object
or to a nested entry of such object, this property returns -1.
or to an
Gets the object containing the current index entry
at some level, either at a top-level entry or a nested entry.
Gets the object containing the current index entry.
Represents a collection of objects.
The property on the class,
and the property on the class
store collections of this type.
For internal use.
For internal use.
Returns the type of items in the collection.
.
Adds an to the current collection.
The item to add.
The index of the newly added item in the current collection.
Removes an from the current collection.
The item to add.
Inserts an into the current collection.
The position of the inserted item in the collection.
The item to insert.
Gets or sets the element at the specified index.
The index in the current collection.
The element at the specified index.
Represents a collection of s used to render objects
at different nesting levels of a .
The style at index 0 of this collection is used to render the top-level entries,
the style at index 1 is used to render sub-entries, and so on.
Gets the that is the owner of the current collection.
Gets the at the specified index.
Creates missing styles as needed (i.e. if Style[2] is accessed,
elements at indices 0, 1 and 2 are created
if they had not been created before).
The index in the current collection.
The element at the specified index.
Represents an alphabetical, optionally multi-level, word index in a .
To create an index, follow these steps:
-
Create an instance of the class, store it in a local variable.
-
For each index entry, create an instance of the class.
-
For each occurrence of each index entry in the document, create an instance of the class,
and set the on it to point to the location of that occurrence in the document.
-
After all occurrences have been added to their entries, and all entries have been added to the ,
add the object created in the first step, to the document. When the document generates, that object will create
the alphabetically sorted word index with clickable page numbers.
Please note that a must be added after all occurrences of all entries contained in it.
If an occurrence appears after the containing it, it is ignored when the index is built.
Initializes a new instance of the class.
Tests whether the property should be serialized.
Tests whether the property should be serialized.
Tests whether the property should be serialized.
Tests whether the property should be serialized.
Tests whether the property should be serialized.
Tests whether the property should be serialized.
Tests whether the property should be serialized.
Tests whether the property should be serialized.
Tests whether the property should be serialized.
True if the property should be serialized, false otherwise.
Tests whether the property should be serialized.
True if the property should be serialized, false otherwise.
Initializes the current object.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Determines how a single entry can split vertically.
This property applies to entries at all levels.
The default is .
Gets or sets a value indicating whether that sub-entries
should appear inline with the main heading rather than on separate indented lines.
The default is false.
Gets or sets a value indicating whether page numbers in the generated index
should be right-aligned.
The default is false.
Gets or sets a character used to fill the empty space between
an index entry's and the page number or numbers
referencing the occurrences of that entry.
This property is only used if
on the current has been set to true.
The default is a dot ('.').
Gets or sets the indent of sub-entries relative to the main index entry.
The default is 1/4 of an inch.
While this property has the type,
only absolute values (such as "10mm", "0.5in" and so on - see )
can be assigned to it.
Gets or sets the hanging indent of the first line of an entry's paragraph
relative to the following lines (used if the list of occurrences and
cross-references for the entry is too long to fit on a single line).
The default is 1/8 of an inch.
While this property has the type,
only absolute values (such as "10mm", "0.5in" and so on - see )
can be assigned to it.
Gets the collection of entries (elements of type )
at the top level of the current index.
This method always returns a non-null,
creating it if it did not exist.
To test whether the current index already contains entries
without creating the collection,
use the property.
Gets a value indicating whether the collection
has been created and contains one or more elements.
Gets the of the "See (...)" text
used to list cross-references between entries of the current .
Note that this style is only applied to the static text of the
format string, but not to the entries' list output by that format.
When the index generates, new objects are created to represent the "See also" cross-references.
As all content objects in a ,
each such object has an inline style that is used to actually render
that object. That style is created on the fly, and the SeeAlsoStyle
is assigned to and
properties of that .
Gets the used for letter headings
generated by the current index.
(A heading is a letter preceding the group of entries beginning with that letter.)
When the index generates, new objects are created to represent the headings.
As all content objects in a ,
each such object has an inline style that is used to actually render
that object. That style is created on the fly, and the HeadingStyle
is assigned to and
properties of that .
Gets the collection containing the styles
used to render entries of the current at different levels.
When the index generates, new objects are created to represent the index entries.
As all content objects in a ,
each such object has an inline style that is used to actually render that object.
That style is created on the fly, and the element of the EntryStyles
collection at the corresponding position (0 for top-level entries, 1 for sub-entries, and so on)
is assigned to and
properties of that .
Gets the style of index entries at the top level.
This is a shortcut to the first (with index 0)
element of the collection.
Gets or sets a that determines how a letter group
(entries starting with the same letter) can split vertically.
The default is .
Note that headings (represented by their letters by default)
are always printed together with their first entry
Gets or sets a string used to format the letter group headings.
The default is "{0}".
Gets or sets a string used to delimit an index entry
and the list of that entry's occurrences (page numbers) in the generated index.
The default is ", " (comma followed by space).
Gets or sets a string used to delimit the occurrences (page numbers)
of an index entry in the generated index.
The default is ", " (comma followed by space).
Gets or sets a format string used to format the page ranges of occurrences
of index entries in the generated index.
The default is "{0}-{1}".
When an index entry occurs on consecutive pages in a document (e.g. on pages 3, 4 and 5),
those occurrences are collapsed into a range ("3-5" in that case).
PageRangeFormat is used to format those ranges.
Gets or sets a format string used to format the "See also"
cross-references in the generated index.
The default is "(see {0})".
Gets or sets a string used to delimit entries when a run-in (see )
index is generated by the current .
The default is ";" (semicolon).
Specifies an end user action on a control produced by a
-derived object
when the containing is shown
by a supporting viewer (e.g. by C1.Win.C1Preview.C1PrintPreviewControl).
The control is clicked.
The mouse pointer is over the control and a mouse button is released.
The mouse pointer is over the control and a mouse button is pressed.
The mouse pointer enters the control.
The mouse pointer leaves the control.
The input focus enters the control.
The input focus leaves the control.
Specifies an action that is to be performed when the TAB key is pressed
on a page containing -derived objects,
while the containing is shown
by a supporting viewer (e.g. by C1.Win.C1Preview.C1PrintPreviewControl).
Focus moves to the next control on the current page,
but does not leave the preview nor goes to another page.
Focus moves to the next control in the document (including across pages).
Focus does not leave the preview control.
Focus moves to the next control on the current page.
When the last control is reached focus goes to the first control on the same page.
Focus moves to the next control in the document.
When the last control is reached focus goes to the first control in the document.
Focus moves to the next control on the current page.
When the last control on the page is reached focus leaves the preview control,
and goes to the next control on the form.
Focus moves to the next control in the document.
When the last control in the document is reached focus leaves the preview control,
and goes to the next control on the form.
Specifies an action that is to be performed when the ENTER key is pressed
on a page containing -derived objects,
while the containing is shown
by a supporting viewer (e.g. by C1.Win.C1Preview.C1PrintPreviewControl).
No action is taken.
The same action as that of the TAB key is taken.
The current form's Accept button is invoked.
The abstract base class for types representing various document-related actions
that can be performed in response to a user action on a control
produced by a object.
When a containing one or more -derived objects
is shown by a supporting viewer control such as C1PrintPreviewControl,
each RenderInputBase object produces a corresponding control on the document page.
E.g. a produces a textbox control where the user can
enter text, a produces a pushbutton, and so on.
The functionality of those input controls in the document can be expanded via "action handlers",
which are similar to C# or VB event handlers that can be assigned to events on many .NET components.
The list of supported events is specified by the enumeration,
and includes mouse click, mouse enter and leave, keyboard focus enter and leave,
and mouse up and down events.
To create and attach a handler to a user action on a -derived object,
follow these general steps:
-
Create an instance of a -derived class of the concrete type
that matches the action that needs to be performed, such as a hyperlink jump or a file operation.
(Those classes include
,
,
,
,
,
,
,
and
.)
-
Some of those classes expose action-specific properties
(such as ).
Adjust the values of those properties as needed.
-
Create an instance of the class, set its
property to the desired user action (such as click or focus enter),
and set its property to the
instance created in the preceding steps.
-
Add the to the
collection of the object.
Note that several objects can be associated
with a single render input control.
The following example shows how to add a button that would jump to the last page
of the current document when clicked, to a document:
C1PrintDocument doc = new C1PrintDocument();
// Create an action handler that would jump to the last page:
ActionHandlerLink ahl = new ActionHandlerLink(new C1LinkTargetPage(PageJumpTypeEnum.Last));
// Create an input action, set its properties:
InputAction ia = new InputAction();
ia.ActionHandler = ahl;
ia.UserAction = UserActionEnum.Click;
// Create a button, add the input action to its actions:
RenderInputButton rbtn = new RenderInputButton("Jump to last page");
rbtn.InputActions.Add(ia);
// Add the button to the document:
doc.Body.Children.Add(rbtn);
// ...add more content to the document...
Describes an that executes a hyperlink jump.
The target of the jump is specified by the instance of
that is assigned to the property.
For details on the use of action handlers, see .
Initializes a new instance of the class,
assigning the property.
An instance of the -derived class
to assign to the property.
Gets or sets the link target associated with the current .
The abstract base class for action handlers performing a file operation such as save or open.
For details on the use of action handlers, see .
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the property.
The file name to assign to the property.
Gets or sets the name of the file associated with the current .
If empty, a file dialog will be shown to the user when the current action handler is invoked.
Represents an action handler that saves or exports a document to a disk file.
If the is not specified when this action handler
is invoked, a file save dialog is shown to the user.
For details on the use of action handlers, see .
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the property.
The file name to assign to the property.
Initializes a new instance of the class,
assigning the and properties.
The file name to assign to the property.
The to assign to the property.
Gets or sets the that will be used
to save or export the document.
Represents an action handler that loads a document (in C1DX or C1D formats) from a disk file.
If the is not specified when this action handler
is invoked, a file open dialog is shown to the user.
For details on the use of action handlers, see .
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the property.
The file name to assign to the property.
Represents an that displays the page setup dialog
allowing the end user to change the page properties of the current .
For details on the use of action handlers, see .
Represents an that prints the current .
For details on the use of action handlers, see .
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the property.
The printer name to assign to the property.
Gets or sets the name of the printer to use.
If empty, a printer select dialog will be shown to the user when the current action handler is invoked.
Represents an that reflows the current .
For details on the use of action handlers, see .
Represents an that changes the document view
in the current viewer control.
For details on the use of action handlers, see .
Initializes a new instance of the class,
assigning the and properties.
A value to assign to the property.
A value to assign to the property.
Gets or sets a value indicating whether to change the view to Facing mode.
Gets or sets a value indicating whether to change the view to Continuous mode.
Represents an that switches to the previous
history entry in the current viewer control.
For details on the use of action handlers, see .
Represents an that switches to the next
history entry in the current viewer control.
Describes the combination of a user action on a control
produced by a -derived object,
and the associated handling.
Objects of this type, describing handling of different user actions, are stored
in the collection of a object,
and define how various user actions on the control produced by that object are handled.
For details on the use of action handlers, see .
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the and properties.
A value to assign to the property.
A value to assign to the property.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets the kind of user action (such as click or focus enter) associated with the current object.
Gets or sets the action handler associated with the current object.
Represents a collection of objects.
Adds an element to the current collection.
The to add.
The index of the added element in the current collection.
Creates a new instance based on the specified user action and handler,
and adds it to the current collection.
The of the new instance.
The of the new instance.
The index of the new element in the current collection.
Inserts an element into the current collection.
The index where to insert the element.
The element to insert.
Removes an element from the current collection.
The element to remove.
Returns the index of the specified element in the current collection.
The element to return the index of.
The index of the specified element in the current collection.
Gets or sets the element at the specified index.
The index in the current collection.
The element at the specified index.
The abstract base class for all Preview Forms input controls.
Derived types represent active UI elements embedded in a
when that document is shown by a supporting viewer (e.g. C1.Win.C1Preview.C1PrintPreviewControl).
Derived classes include
,
,
,
and
.
Represents an object that exposes a property.
Provides an event fired when the value has changed.
Gets or sets the value.
Occurs when the has changed.
Initializes a new instance of the object.
Indicates whether the should be serialized.
True if the cursor should be serialized, false otherwise.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Gets the input value.
The input value.
Sets the input value.
The value to set.
Called when the has changed.
Gets the control type.
The control type.
Initializes the input control.
The control to initialize.
Context that should be used to get calculated style properties.
Returns the preffered size of the input control in pixels.
Context that should be used to get calculated style properties.
OUT: Width of the control.
OUT: Height of the control.
Called to test whether the underlying control requires a parent
to correctly process the WM_PRINT message.
True (override this method to change that).
Called to test whether the selection on the parent control
should be reset when the underlying control receives input focus.
False (override this method to change that).
Creates the underlying .
Context that should be used to to get calculated style properties.
The newly created control.
Gets or sets a value indicating whether the current control is read-only.
For read-only controls, all input actions are still fired, but the control's
value cannot be changed. The default is false.
Gets or sets a value indicating whether the current control is printed.
If true (default), the content of the control is printed normally.
Otherwise, it is not printed or exported. This might be used for example
to provide help (invisible in the printed document)
for form fields that are to be filled.
Gets or sets the text that appears in the status line of the preview control
when the current control has focus.
Gets or sets the tooltip associated with the current control.
Gets or sets the cursor used when the mouse is over the current control.
Gets the collection of objects
describing the pairs of supported user actions and handlers associated with those actions.
This property always returns a non-null input actions' collection,
initializing it if it has not been initialized yet.
Use to test whether there are any input actions
without initializing .
Gets a value indicating whether the current object's
collection has been initialized and contains one or more fragments.
Represents a Preview Forms pushbutton in a .
When the document is shown by a supporting viewer (e.g. C1.Win.C1Preview.C1PrintPreviewControl),
produces an active pushbutton control.
The abstract base class for button-like input controls (button, check box, radio button).
Initializes a new instance of the class.
Indicates whether should be serialized.
True if TextAlign should be serialized, false otherwise.
Gets the default cursor.
.
Initializes the render object.
Gets the default text alignment.
.
Assigns (copies) properties from another to the current object.
Calls the base method,
then copies -specific properties if source is a .
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Initializes the control.
The to initialize.
Context that should be used to get calculated style properties.
Gets or sets the text of the button.
Gets or sets the alignment of the button text.
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the button text.
A string to assign to the property.
Assigns (copies) properties from another to the current object.
Calls the base method.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
For internal use.
For internal use.
For internal use.
For internal use.
Returns the preffered size of the control in pixels.
Context that should be used to get calculated style properties.
OUT: Width of the control.
OUT: Height of the control.
Gets or sets a value indicating whether the current button should function
as an "Accept button", so that its action is executed when the ENTER is pressed
in a supporting viewer control showing the document containing this button.
Describes the type of mark which is used in the ScalableCheckBox
and RenderInputCheckBoxOptions.
The default style, as in Windows.
Cross, as in MS Word.
Represents a checkbox.
Initializes a new instance of the class.
Initializes a new instance of the class.
The text to use as the checkbox label.
Initializes the render object.
Gets the default text alignment.
.
Assigns (copies) properties from another to the current object.
Calls the base method,
then copies -specific properties if source is a .
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Gets the checkbox value.
True if the checkbox is checked, false otherwise.
Sets the checkbox value.
A value.
Gets the checkbox control type.
.
Initializes the control.
The to initialize.
Gets the desired (auto) size of the control.
Context that should be used to get calculated style properties.
OUT: the width of the control.
OUT: the height of the control.
Gets or sets the value indicating whether the check box is checked.
Gets or sets the visual style of the check mark used by the control.
Gets or sets the horizontal and vertical alignment of the check box on the control.
Represents an item in the
collection of a .
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the property.
A string to assign to the property.
Initializes a new instance of the class,
assigning the and properties.
A string to assign to the property.
Arbitrary value to assign to the property.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Returns the string representation of the current object.
The value of the property.
Gets or sets a text representing the current item in the dropdown list of a .
Gets or sets arbitrary user data associated with the current item.
Represents a collection of objects.
Adds a to the current collection.
The item to add.
Index of the added item in the current collection.
Creates a new , initializing its
with the passed string, and adds it to the current collection.
The text of the item to add.
Index of the added item in the current collection.
Inserts a into the current collection.
The position where to insert the item.
The item to insert.
Removes a from the current collection.
The item to remove.
Returns the index of a in the current collection.
The item to search for.
The index of the specified item, or -1 if none was found.
Gets or sets the element at the specified index.
The index in the current collection.
The element at the specified index.
Represents a Preview Forms combobox (a textbox with an attached dropdown) in a .
When the document is shown by a supporting viewer (e.g. C1.Win.C1Preview.C1PrintPreviewControl),
produces an active combobox control.
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning from the specified strings.
The strings that are used to initialize the array.
For internal use.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Returns the preffered size of the control in pixels.
Context that should be used to get calculated style properties.
OUT: Width of the control.
OUT: Height of the control.
Gets or sets the string shown in the textbox control.
Gets or sets the char used to hide real characters when entering passwords.
The default value of this property is '\0', which disables hiding.
Gets or sets the of the combobox.
Gets the collection of objects
representing the items in the combobox dropdown.
This method always returns a non-null,
initializing it if it did not exist.
To test whether a combobox already contains items
without creating the collection,
use the property.
Gets a value indicating whether the collection
has been initialized and contains one or more elements.
Obsolete. Not supported.
Gets or sets a value indicating whether to draw borders around the current
input control.
Represents a Preview Forms radio button in a .
When the document is shown by a supporting viewer (e.g. C1.Win.C1Preview.C1PrintPreviewControl),
produces an active radio button control.
Several objects can be combined into a group,
in which case checking one button will un-check other buttons in that group
(see the property for details).
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the property.
A string to assign to the property.
Initializes a new instance of the class,
assigning the and properties.
A string to assign to the property.
A string to assign to the property.
Initializes a new instance of the class,
assigning the ,
and properties.
A string to assign to the property.
A string to assign to the property.
A value to assign to the property.
Initializes a new instance of the class,
assigning the and properties.
A string to assign to the property.
A value to assign to the property.
For internal use.
For internal use.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
For internal use.
For internal use.
For internal use.
For internal use.
Returns the preffered size of the control in pixels.
Context that should be used to get calculated style properties.
OUT: Width of the control.
OUT: Height of the control.
Gets or sets a value indicating whether the current radio button is checked.
Gets or sets the alignment of the checkbox relative to the text of the current radio button.
Gets or sets the group index of the current radio button.
Only one radio button in a group can be checked at any time.
By default, all objects are placed in
a single group with the GroupIndex set to -1.
Represents a Preview Forms textbox in a .
When the document is shown by a supporting viewer (e.g. C1.Win.C1Preview.C1PrintPreviewControl),
produces an active textbox control.
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the property.
A string to assign to the property.
For internal use.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Returns the preffered size of the control in pixels.
Context that should be used to get calculated style properties.
OUT: Width of the control.
OUT: Height of the control.
Gets or sets the text shown in the textbox.
Gets or sets the char used to hide real characters when entering passwords.
The default value of this property is '\0', which disables hiding.
Obsolete. Not supported.
Gets or sets a value indicating whether to draw borders around the current
input control.
Specifies how borders are drawn when the object is split between pages.
Borders are not drawn where the object is split.
Square borders are drawn where the object is split.
Borders are drawn where the object is split.
If the border is round (see ,
),
round borders are drawn where the object is split.
Defines the splitting behavior of a render object.
The object should not be split between pages
(i.e. should always be kept together on a single page).
The object can be split if it does not fit onto the current page.
The object can be split only if it is too large to fit on an empty
page. In that case, the object is split immediately. Otherwise, a
new page is started and the object is placed on it without
splitting.
If the object does not fit on the current page (column),
a new page (column) is started; if the object does not fit
on that page (column), it is split as needed after that.
Defines the various breaks which can be forced before or after render object.
No break.
New page should be started.
New column should be started.
New line on inline flow should be started.
Specifies the visibility of an object.
Object is visible.
Object is not visible, but takes up space and affects the layout of other objects as if it were visible.
Object is not visible, its size is zero and it does not affect the layout of other objects.
Represents the collection of RenderObject objects.
Represents a collection of objects.
Used to store objects in the of a
(see ),
and child objects contained in another
(see ).
Called after the collection has been cleared.
Called after an item has been removed.
The item index.
The item.
Called after an item has been set.
The item index.
The old item.
The new item.
Called when an item is about to be set.
The item index.
The old item.
The new item.
Called when an item is about to be iserted.
The item index.
The item.
Returns typeof().
typeof().
Adds the specified to the current collection.
The object to add.
The index of the newly added object in the current collection.
Removes the specified from the current collection.
The object to remove.
Inserts the specified into the current collection.
The index where to insert the object.
The object to insert.
Searches the current collection for an object with the specified .
The name to search for.
Index of the object in the current collection, or -1 if no object was found.
Searches the current collection for an object with the specified .
The name to search for.
The object in the current collection, or null if no object was found.
Searches the current collection for an object that contains an anchor
with the specified name in its collection.
The name of the anchor to search for.
OUT: contains the object with the specified name.
Returns the found render object or null if not found.
The object containing the specified anchor, or null if no object was found.
Searches the current collection for a
with the specified value of the property.
The Id to search for.
The render object with the specified Id, or null of no such object was found.
Searches the current collection for a
with the specified vlaue of the property.
The original object to search for.
The render object with the specified , or null of no such object was found.
Gets the with the specified .
Gets or sets the at the specified index.
Represents a paragraph in a .
Paragraphs can contain inline text and images, possibly rendered using different styles.
The content of a paragraph is accessible via the property.
The abstract base class for render object types representing text
( and ) in a .
Initializes a new instance of the class.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Gets a value indicating whether the current object represents a non-empty text.
Gets the lenght of text represented by the current object.
(Do not use this property to test whether a non-empty text is assigned to the current object,
use instead.)
Gets the collection of objects representing tab stops
associated with the current text.
This method always returns a non-null,
initializing it if it did not exist.
To test whether the current object has any tab stops defined
without creating the collection,
use the property.
Gets a value indicating whether the collection
has been initialized and contains one or more elements.
Initializes a new instance of the class.
Initializes a new instance of the class,
specifying a to use.
A to use
(the method
is used to copy the specified style to the current object's ).
Initializes a new instance of the class,
specifying a to use.
The default font for the current paragraph.
Initializes a new instance of the class,
specifying the default font and text color.
The default font for the current paragraph.
The default text color for the current paragraph.
Initializes a new instance of the class,
specifying the default font, text color and horizontal alignment.
The default font for the current paragraph.
The default text color for the current paragraph.
The horizontal alignment for the current paragraph.
Initializes a new instance of the class,
specifying the default font and horizontal alignment.
The default font for the current paragraph.
The horizontal alignment for the current paragraph.
Initializes a new instance of the class,
specifying the horizontal alignment.
The horizontal alignment for the current paragraph.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Gets the representing
the content (text and images) of the current paragraph.
This method always returns a non-null,
initializing it if it did not exist.
To test whether a paragraph already contains content
without creating the collection,
use the property.
Gets a value indicating whether the collection
has been initialized and contains one or more elements.
Gets a value indicating whether the collection
has been initialized and contains one or more elements.
This property is an alias for the property.
Gets the count of characters in the current paragraph.
Each non-text object (such as )
counts as one character.
Gets or sets the text of the current paragraph.
The getter for this property concatenates and returns
the texts of all objects
in the current paragraph.
The setter clears the of the current paragraph,
and then adds the specified
as a single .
The abstract base class for inline text and images, rendered using a single style,
in the of a object.
Initializes a new instance of the class.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
For internal use.
Assigns (copies) properties from another to the current object.
The object to copy the properties from.
Creates a copy of the current object.
The newly created object.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Gets or sets the associated with the current paragraph object.
Gets the associated with the current paragraph object.
Gets the containing
the current paragraph object.
Gets the containing
the current paragraph object.
Gets the containing
the current paragraph object.
Gets the index of the current paragraph object
in the containing .
Gets the character 0-based position of the current paragraph object
in the text of the paragraph.
Each non-text paragraph object ()
counts as one character.
Gets the length of the current paragraph object in characters.
For non-text objects (), this
property returns 1.
Gets or sets arbitrary data associated with the current paragraph object.
Gets the first of all fragments
produced by the containing that contains
the current .
Gets the last of all fragments
produced by the containing that contains
the current .
Represents a run of text, rendered using a single style,
in the of a .
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the property,
and specifying the .
A string assigned to the property of the current object.
A to use
(the method
is used to copy the specified style to the current object's ).
Initializes a new instance of the class,
assigning the property,
and specifying the .
A string assigned to the property of the current object.
Initializes a new instance of the class,
assigning the property,
and specifying the font.
A string assigned to the property of the current object.
The font to use.
Initializes a new instance of the class,
assigning the property,
and specifying the text color.
A string assigned to the property of the current object.
The text color to use.
Initializes a new instance of the class,
assigning the property,
and specifying the text position.
A string assigned to the property of the current object.
The text position to use.
Initializes a new instance of the class,
assigning the property,
and specifying the font and text color.
A string assigned to the property of the current object.
The font to use.
The text color to use.
Initializes a new instance of the class,
assigning the property,
and specifying the font and text position.
A string assigned to the property of the current object.
The font to use.
The text position to use.
Initializes a new instance of the class,
assigning the property,
and specifying the text color and position.
A string assigned to the property of the current object.
The text color to use.
The text position to use.
Initializes a new instance of the class,
assigning the property,
and specifying the font, text color and position.
A string assigned to the property of the current object.
The font to use.
The text color to use.
The text position to use.
Returns the length of this ParagraphText object.
The text length.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
For internal use.
Gets or sets the text of the current .
Represents an inline image
in the of a .
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the property,
and specifying the .
An image assigned to the property of the current object.
A to use
(the method
is used to copy the specified style to the current object's ).
Initializes a new instance of the class,
assigning the property.
An image assigned to the property of the current object.
Initializes a new instance of the class,
assigning the property.
A string that is assigned to the property.
Returns the length of the current paragraph object.
1.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets an that is
rendered by the current object.
Gets or sets the name of an image that is
rendered by the current object.
When the current object renders, the actual image is retrieved by this name
from the of the containing .
Represents a collection of objects
that is the
of a .
For internal use.
Adds a to the current paragraph content.
The to add.
The index of the added object in the current collection.
Removes a from the current paragraph content.
The object to remove.
Adds a text string to the current paragraph content.
The text string to add.
A object representing the specified text string.
This method creates a ,
initializes it with the specified text, and adds it
to the current collection.
Adds a text string with the specified style to the current paragraph content.
The text string to add.
The style to use to render the string.
A object representing the specified text string.
This method creates a ,
initializes it with the specified text and style, and adds it
to the current collection.
Adds a text string with the specified font to the current paragraph content.
The text string to add.
The font to use to render the string.
A object representing the specified text string.
This method creates a ,
initializes it with the specified text and font, and adds it
to the current collection.
Adds a text string with the specified text color to the current paragraph content.
The text string to add.
The text color to use to render the string.
A object representing the specified text string.
This method creates a ,
initializes it with the specified text and text color, and adds it
to the current collection.
Adds a text string with the specified text position to the current paragraph content.
The text string to add.
The text position to use to render the string.
A object representing the specified text string.
This method creates a ,
initializes it with the specified text and text position, and adds it
to the current collection.
Adds a text string with the specified font and text color to the current paragraph content.
The text string to add.
The font to use to render the string.
The text color to use to render the string.
A object representing the specified text string.
This method creates a ,
initializes it with the specified text, font and text color, and adds it
to the current collection.
Adds a text string with the specified font and text position to the current paragraph content.
The text string to add.
The font to use to render the string.
The text position to use to render the string.
A object representing the specified text string.
This method creates a ,
initializes it with the specified text, font and text position, and adds it
to the current collection.
Adds a text string with the specified text color and position to the current paragraph content.
The text string to add.
The text color to use to render the string.
The text position to use to render the string.
A object representing the specified text string.
This method creates a ,
initializes it with the specified text, text color and position, and adds it
to the current collection.
Adds a text string with the specified font, text color and position to the current paragraph content.
The text string to add.
The font to use to render the string.
The text color to use to render the string.
The text position to use to render the string.
A object representing the specified text string.
This method creates a ,
initializes it with the specified text, font, text color and position, and adds it
to the current collection.
Adds a text hyperlink to the current paragraph content.
The text string to add.
The name of the anchor which is the target of the hyperlink.
A object representing the specified text string,
associated with the specified hyperlink.
This method creates a ,
initializes it with the specified text,
sets the on that object to a
initialized with ,
and adds it to the current collection.
Adds a text hyperlink with a specified style to the current paragraph content.
The text string to add.
The name of the anchor which is the target of the hyperlink.
A style used to render the string.
A object representing the specified text string,
associated with the specified hyperlink.
This method creates a ,
initializes it with the specified text and style,
sets the on that object to a
initialized with ,
and adds it to the current collection.
Adds a text hyperlink to the current paragraph content.
The text string to add.
A which is the target of the hyperlink.
A object representing the specified text string,
associated with the specified hyperlink.
This method creates a ,
initializes it with the specified text,
sets the on that object to a
initialized with ,
and adds it to the current collection.
Adds a text hyperlink with a specified style to the current paragraph content.
The text string to add.
A which is the target of the hyperlink.
A style used to render the string.
A object representing the specified text string,
associated with the specified hyperlink.
This method creates a ,
initializes it with the specified text and style,
sets the on that object to a
initialized with ,
and adds it to the current collection.
Adds a text hyperlink to the current paragraph content.
The text string to add.
A which is the target of the hyperlink.
A object representing the specified text string,
associated with the specified hyperlink.
This method creates a ,
initializes it with the specified text,
sets the on that object to a
initialized with ,
and adds it to the current collection.
Adds a text hyperlink to the current paragraph content.
The text string to add.
A which is the target of the hyperlink.
A object representing the specified text string,
associated with the specified hyperlink.
This method creates a ,
initializes it with the specified text,
sets the on that object to a
initialized with ,
and adds it to the current collection.
Adds an image hyperlink to the current paragraph content.
The image to add.
The name of the anchor which is the target of the hyperlink.
A object representing the specified image,
associated with the specified hyperlink.
This method creates a ,
initializes it with the specified image,
sets the on that object to a
initialized with ,
and adds it to the current collection.
Adds an image hyperlink to the current paragraph content.
The image to add.
A which is the target of the hyperlink.
A object representing the specified image,
associated with the specified hyperlink.
This method creates a ,
initializes it with the specified image,
sets the on that object to a
initialized with ,
and adds it to the current collection.
Adds an image hyperlink to the current paragraph content.
The image to add.
A which is the target of the hyperlink.
A object representing the specified image,
associated with the specified hyperlink.
This method creates a ,
initializes it with the specified image,
sets the on that object to a
initialized with ,
and adds it to the current collection.
Adds an image hyperlink to the current paragraph content.
The image to add.
A which is the target of the hyperlink.
A object representing the specified image,
associated with the specified hyperlink.
This method creates a ,
initializes it with the specified image,
sets the on that object to a
initialized with ,
and adds it to the current collection.
Adds an image to the current paragraph content.
The image to add.
A object representing the specified image.
This method creates a ,
initializes it with the specified image,
and adds it to the current collection.
Adds an image to the current paragraph content.
A string that is assigned to the property.
A object representing the specified named image.
This method creates a ,
initializes it with the specified image name,
and adds it to the current collection.
Adds an image with a specified style to the current paragraph content.
The image to add.
A style used to render the image.
A object representing the specified image.
This method creates a ,
initializes it with the specified image and style,
and adds it to the current collection.
Gets the containing object.
Gets or sets the at the specified index.
The index in the current collection.
The at the specified index.
Represents an RTF text in a .
Initializes a new instance of the class.
Initializes a new instance of the class,
using the specified RTF string and style.
A RTF-formatted string assigned to the property.
A to use
(the method
is used to copy the specified style to the current object's ).
Initializes a new instance of the class,
using the specified RTF string and style.
A RTF-formatted string assigned to the property.
For internal use.
For internal use.
For internal use.
For internal use.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Loads the content of the current from a disk file
containing RTF-formatted data.
The name of the file to load.
Loads the content of the current from a disk file
containing data in a specified format.
The name of the file to load.
The type of data in the file.
Loads the content of the current from a stream
containing RTF-formatted data.
The stream to load data from.
Loads the content of the current from a stream
containing data in a specified format.
The stream to load data from.
The type of data in the stream.
For internal use.
Gets a value indicating whether the property
has been initialized and has non-zero length.
Gets or sets the RTF-formatted text represented by the current object.
Gets or sets a value indicating whether or not the current
will automatically format Uniform Resource Locators (URLs)
when those are found in text assigned to the property.
Gets the "real" length of the text assigned to the property.
Only the actual text characters are counted, RTF tags are not included in the count.
The abstract base class representing the geometric properties of a shape.
Used by and derived classes.
Initializes a new instance of the class.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
The abstract base class for classes representing geometric shapes (lines, polygons and so on)
in a .
Initializes a new instance of the class.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
For internal use.
Gets the object describing the geometric shape
represented by the current object.
The abstract base class representing the geometric properties of a line shape.
Used by and derived classes.
Initializes a new instance of the class.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
The abstract base class for classes representing line-based shapes (lines and polygons)
in a .
Initializes a new instance of the class.
For internal use only.
Gets the object describing the geometric line
represented by the current object.
Represents the geometric properties of a object.
Initializes a new instance of the class.
The points that this line connects are set to the left top and right bottom
corners of the containing object.
Gets or sets the X coordinate of the first of the two points that the line connects.
Gets or sets the Y coordinate of the first of the two points that the line connects.
Gets or sets the X coordinate of the second of the two points that the line connects.
Gets or sets the Y coordinate of the second of the two points that the line connects.
Represents a line shape in a .
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the coordinates of the two points that the line connects.
The X coordinate of the first of the two points that the line connects.
The Y coordinate of the first of the two points that the line connects.
The X coordinate of the second of the two points that the line connects.
The Y coordinate of the second of the two points that the line connects.
Gets the object describing the geometric line
represented by the current object.
The coordinates of the line are relative to the left top corner
of the current object.
Represents the geometric properties of a object.
Initializes a new instance of the class.
The property is set to null.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets the array of points
defining the polygon.
Gets or sets a value indicating whether the polygon is closed
(i.e. the last point in the array is automatically connected to the first one)
or not.
Represents an open or closed polygon shape in a .
Initializes a new instance of the class.
For internal use only.
Gets the object describing the geometric polygon
represented by the current object.
The points' coordinates are relative to the left top corner
of the current object.
Represents the geometric properties of a rectangle,
also serves as the base for classes describing
certain other shapes (such as round rectangle, arc and pie).
Used by and derived classes.
Initializes a new instance of the class.
The location and size of the rectangle are set to those of the containing
object.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets the X coordinate of the current rectangle.
Gets or sets the Y coordinate of the current rectangle.
Gets or sets the width of the current rectangle.
Gets or sets the height of the current rectangle.
Represents a rectangle in a .
This is also the base class for and classes.
Initializes a new instance of the class.
The location and size of the rectangle are set to those of the current object.
Initializes a new instance of the class,
assigning the width and height of the rectangle.
The location of the rectangle is set to the location of the current .
The width of the rectangle.
The height of the rectangle.
Initializes a new instance of the class,
assigning the width and height of the rectangle, and the used to draw it.
The location of the rectangle is set to the location of the current .
The width of the rectangle.
The height of the rectangle.
The used to draw the rectangle.
Initializes a new instance of the class,
assigning the width and height of the rectangle, the used to draw it, and the fill color.
The location of the rectangle is set to the location of the current .
The width of the rectangle.
The height of the rectangle.
The used to draw the rectangle.
The color used to fill the rectangle.
Initializes a new instance of the class,
assigning the width and height of the rectangle, the used to draw it, and the fill brush.
The location of the rectangle is set to the location of the current .
The width of the rectangle.
The height of the rectangle.
The used to draw the rectangle.
The brush used to fill the rectangle.
Initializes a new instance of the class,
assigning the location and the size of the rectangle.
The X coordinate of the rectangle, relative to the current object's location.
The Y coordinate of the rectangle, relative to the current object's location.
The width of the rectangle.
The height of the rectangle.
Initializes a new instance of the class,
assigning the location and the size of the rectangle,
and the used to draw it.
The X coordinate of the rectangle, relative to the current object's location.
The Y coordinate of the rectangle, relative to the current object's location.
The width of the rectangle.
The height of the rectangle.
The used to draw the rectangle.
Initializes a new instance of the class,
assigning the location and the size of the rectangle,
the used to draw it, and the fill color.
The X coordinate of the rectangle, relative to the current object's location.
The Y coordinate of the rectangle, relative to the current object's location.
The width of the rectangle.
The height of the rectangle.
The used to draw the rectangle.
The color used to fill the rectangle.
Initializes a new instance of the class,
assigning the location and the size of the rectangle,
the used to draw it, and the fill brush.
The X coordinate of the rectangle, relative to the current object's location.
The Y coordinate of the rectangle, relative to the current object's location.
The width of the rectangle.
The height of the rectangle.
The used to draw the rectangle.
The brush used to fill the rectangle.
Gets the object describing the geometric rectangle
represented by the current object.
The coordinates of the rectangle are relative to the left top corner
of the current object.
Represents an ellipse in a .
Initializes a new instance of the class.
The location and size of the ellipse are set to those of the current object.
Initializes a new instance of the class,
assigning the width and height of the ellipse.
The location of the ellipse is set to the location of the current .
The width of the ellipse.
The height of the ellipse.
Initializes a new instance of the class,
assigning the width and height of the ellipse, and the used to draw it.
The location of the ellipse is set to the location of the current .
The width of the ellipse.
The height of the ellipse.
The used to draw the ellipse.
Initializes a new instance of the class,
assigning the width and height of the ellipse, the used to draw it, and the fill color.
The location of the ellipse is set to the location of the current .
The width of the ellipse.
The height of the ellipse.
The used to draw the ellipse.
The fill color.
Initializes a new instance of the class,
assigning the width and height of the ellipse, the used to draw it, and the fill brush.
The location of the ellipse is set to the location of the current .
The width of the ellipse.
The height of the ellipse.
The used to draw the ellipse.
The fill brush.
Initializes a new instance of the class,
assigning the location and the size of the ellipse.
The X coordinate of the ellipse.
The Y coordinate of the ellipse.
The width of the ellipse.
The height of the ellipse.
Initializes a new instance of the class,
assigning the location and the size of the ellipse, and the used to draw it.
The X coordinate of the ellipse.
The Y coordinate of the ellipse.
The width of the ellipse.
The height of the ellipse.
The used to draw the ellipse.
Initializes a new instance of the class,
assigning the location and the size of the ellipse, the used to draw it, and the fill color.
The X coordinate of the ellipse.
The Y coordinate of the ellipse.
The width of the ellipse.
The height of the ellipse.
The used to draw the ellipse.
The fill color.
Initializes a new instance of the class,
assigning the location and the size of the ellipse, the used to draw it, and the fill brush.
The X coordinate of the ellipse.
The Y coordinate of the ellipse.
The width of the ellipse.
The height of the ellipse.
The used to draw the ellipse.
The fill brush.
Gets the object describing the geometric ellipse
represented by the current object.
The coordinates of the ellipse are relative to the left top corner
of the current object.
Represents the geometric properties of a pie.
Used by class.
Initializes a new instance of the class.
is set to 0, while is set to 360 degrees,
thus making this a complete ellipse.
The location and size of the ellipse are set to those of the containing object.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets the angle, measured in degrees, clockwise from the X axis
to the first side of the sector defining the current shape.
Gets or sets the angle, measured in degrees, clockwise from
to the second side of the sector defining the current shape.
Represents a pie shape (a closed shape consisting of an arc of an ellipse,
with lines going from the start and end points of the arc to the ellipse's center)
in a .
Initializes a new instance of the class.
The start angle of the pie is set to 0, while the sweep angle is set to 360 degrees,
thus making it a complete ellipse.
The location and size of the ellipse are set to those of the current object.
Initializes a new instance of the class,
assigning the width, height, and start and sweep angles of the pie shape.
The location of the shape is set to the location of the current .
The width of the ellipse containing the pie shape.
The height of the ellipse containing the pie shape.
The angle, in degrees, clockwise from the X axis
to the start of the pie's arc.
The angle, measured in degrees, clockwise from
to the end of the pie's arc.
Initializes a new instance of the class,
assigning the width, height, start and sweep angles of the pie shape,
and the used to draw the shape.
The location of the shape is set to the location of the current .
The width of the ellipse containing the pie shape.
The height of the ellipse containing the pie shape.
The angle, in degrees, clockwise from the X axis
to the start of the pie's arc.
The angle, measured in degrees, clockwise from
to the end of the pie's arc.
The used to draw the pie shape.
Initializes a new instance of the class,
assigning the width, height, start and sweep angles of the pie shape,
the used to draw the shape, and the fill color.
The location of the shape is set to the location of the current .
The width of the ellipse containing the pie shape.
The height of the ellipse containing the pie shape.
The angle, in degrees, clockwise from the X axis
to the start of the pie's arc.
The angle, measured in degrees, clockwise from
to the end of the pie's arc.
The used to draw the pie shape.
The shape fill color.
Initializes a new instance of the class,
assigning the width, height, start and sweep angles of the pie shape,
the used to draw the shape, and the fill brush.
The location of the shape is set to the location of the current .
The width of the ellipse containing the pie shape.
The height of the ellipse containing the pie shape.
The angle, in degrees, clockwise from the X axis
to the start of the pie's arc.
The angle, measured in degrees, clockwise from
to the end of the pie's arc.
The used to draw the pie shape.
The shape fill brush.
Initializes a new instance of the class,
assigning the location, size, and start and sweep angles of the pie shape.
The X coordinate of the ellipse containing the pie shape.
The Y coordinate of the ellipse containing the pie shape.
The width of the ellipse containing the pie shape.
The height of the ellipse containing the pie shape.
The angle, in degrees, clockwise from the X axis
to the start of the pie's arc.
The angle, measured in degrees, clockwise from
to the end of the pie's arc.
Initializes a new instance of the class,
assigning the location, size, start and sweep angles of the pie shape,
and the used to draw the shape.
The X coordinate of the ellipse containing the pie shape.
The Y coordinate of the ellipse containing the pie shape.
The width of the ellipse containing the pie shape.
The height of the ellipse containing the pie shape.
The angle, in degrees, clockwise from the X axis
to the start of the pie's arc.
The angle, measured in degrees, clockwise from
to the end of the pie's arc.
The used to draw the pie shape.
Initializes a new instance of the class,
assigning the location, size, start and sweep angles of the pie shape,
the used to draw the shape, and the fill color.
The X coordinate of the ellipse containing the pie shape.
The Y coordinate of the ellipse containing the pie shape.
The width of the ellipse containing the pie shape.
The height of the ellipse containing the pie shape.
The angle, in degrees, clockwise from the X axis
to the start of the pie's arc.
The angle, measured in degrees, clockwise from
to the end of the pie's arc.
The used to draw the pie shape.
The shape fill color.
Initializes a new instance of the class,
assigning the location, size, start and sweep angles of the pie shape,
the used to draw the shape, and the fill brush.
The X coordinate of the ellipse containing the pie shape.
The Y coordinate of the ellipse containing the pie shape.
The width of the ellipse containing the pie shape.
The height of the ellipse containing the pie shape.
The angle, in degrees, clockwise from the X axis
to the start of the pie's arc.
The angle, measured in degrees, clockwise from
to the end of the pie's arc.
The used to draw the pie shape.
The shape fill brush.
Gets the object describing the pie shape
represented by the current object.
The coordinates of the ellipse containing the pie shape are relative to the left top corner
of the current object.
Represents the geometric properties of an arc.
Used by class.
Initializes a new instance of the class.
is set to false.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets a value indicating whether the current arc should be closed
(i.e. the start and end points of the arc should be connected by a straight line)
or not.
The default value of this property is false.
Represents an arc of an ellipse in a .
Initializes a new instance of the class.
The start angle of the arc is set to 0, while the sweep angle is set to 360 degrees,
thus making it a complete ellipse.
The location and size of the arc's ellipse are set to those of the current object.
Initializes a new instance of the class,
assigning the width, height, and start and sweep angles of the arc.
The location of the arc's ellipse is set to the location of the current .
The width of the ellipse containing the arc.
The height of the ellipse containing the arc.
The angle, in degrees, clockwise from the X axis
to the start of the arc.
The angle, measured in degrees, clockwise from
to the end of the arc.
Initializes a new instance of the class,
assigning the width, height, start and sweep angles of the arc,
and the used to draw the arc.
The location of the arc's ellipse is set to the location of the current .
The width of the ellipse containing the arc.
The height of the ellipse containing the arc.
The angle, in degrees, clockwise from the X axis
to the start of the arc.
The angle, measured in degrees, clockwise from
to the end of the arc.
The used to draw the arc.
Initializes a new instance of the class,
assigning the width, height, start and sweep angles of the arc,
the used to draw the arc,
and the color used to fill the segment formed by the arc and a line connecting its ends.
The location of the arc's ellipse is set to the location of the current .
The width of the ellipse containing the arc.
The height of the ellipse containing the arc.
The angle, in degrees, clockwise from the X axis
to the start of the arc.
The angle, measured in degrees, clockwise from
to the end of the arc.
The used to draw the arc.
The fill color.
Initializes a new instance of the class,
assigning the width, height, start and sweep angles of the arc,
the used to draw the arc,
and the brush used to fill the segment formed by the arc and a line connecting its ends.
The location of the arc's ellipse is set to the location of the current .
The width of the ellipse containing the arc.
The height of the ellipse containing the arc.
The angle, in degrees, clockwise from the X axis
to the start of the arc.
The angle, measured in degrees, clockwise from
to the end of the arc.
The used to draw the arc.
The fill brush.
Initializes a new instance of the class,
assigning the location, size, and start and sweep angles of the arc.
The X coordinate of the ellipse containing the arc.
The Y coordinate of the ellipse containing the arc.
The width of the ellipse containing the arc.
The height of the ellipse containing the arc.
The angle, in degrees, clockwise from the X axis
to the start of the arc.
The angle, measured in degrees, clockwise from
to the end of the arc.
Initializes a new instance of the class,
assigning the location, size, and start and sweep angles of the arc,
and the used to draw the arc.
The X coordinate of the ellipse containing the arc.
The Y coordinate of the ellipse containing the arc.
The width of the ellipse containing the arc.
The height of the ellipse containing the arc.
The angle, in degrees, clockwise from the X axis
to the start of the arc.
The angle, measured in degrees, clockwise from
to the end of the arc.
The used to draw the arc.
Initializes a new instance of the class,
assigning the location, size, and start and sweep angles of the arc,
the used to draw the arc,
and the color used to fill the segment formed by the arc and a line connecting its ends.
The X coordinate of the ellipse containing the arc.
The Y coordinate of the ellipse containing the arc.
The width of the ellipse containing the arc.
The height of the ellipse containing the arc.
The angle, in degrees, clockwise from the X axis
to the start of the arc.
The angle, measured in degrees, clockwise from
to the end of the arc.
The used to draw the arc.
The fill color.
Initializes a new instance of the class,
assigning the location, size, and start and sweep angles of the arc,
the used to draw the arc,
and the brush used to fill the segment formed by the arc and a line connecting its ends.
The X coordinate of the ellipse containing the arc.
The Y coordinate of the ellipse containing the arc.
The width of the ellipse containing the arc.
The height of the ellipse containing the arc.
The angle, in degrees, clockwise from the X axis
to the start of the arc.
The angle, measured in degrees, clockwise from
to the end of the arc.
The used to draw the arc.
The fill brush.
Gets the object describing the arc
represented by the current object.
The coordinates of the ellipse containing the arc are relative to the left top corner
of the current object.
Represents the geometric properties of a rectangle with rounded corners.
Used by the class.
Initializes a new instance of the class.
The location and size of the rectangle are set to those of the containing
object.
The dimensions of the ellipse used to draw the rounded corners are set
to 5% of the corresponding rectangle's dimensions.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets the width of the ellipse used to draw the rounded corners of the rectangle.
The default value of this property is calculated as 5% of the width of the rectangle.
Gets or sets the height of the ellipse used to draw the rounded corners of the rectangle.
The default value of this property is calculated as 5% of the height of the rectangle.
Represents a rectangle with rounded corners in a .
Initializes a new instance of the class.
The location and size of the rectangle are set to those of the current object.
The dimensions of the ellipse used to draw the rounded corners are set
to 5% of the corresponding rectangle's dimensions.
Initializes a new instance of the class,
assigning the width and height of the rectangle.
The location of the rectangle is set to the location of the current .
The dimensions of the ellipse used to draw the rounded corners are set
to 5% of the corresponding rectangle's dimensions.
The width of the rectangle.
The height of the rectangle.
Initializes a new instance of the class,
assigning the width and height of the rectangle, and the used to draw it.
The location of the rectangle is set to the location of the current .
The dimensions of the ellipse used to draw the rounded corners are set
to 5% of the corresponding rectangle's dimensions.
The width of the rectangle.
The height of the rectangle.
The used to draw the rectangle.
Initializes a new instance of the class,
assigning the width and height of the rectangle, the used to draw it, and the fill color.
The location of the rectangle is set to the location of the current .
The dimensions of the ellipse used to draw the rounded corners are set
to 5% of the corresponding rectangle's dimensions.
The width of the rectangle.
The height of the rectangle.
The used to draw the rectangle.
The color used to fill the rectangle.
Initializes a new instance of the class,
assigning the width and height of the rectangle, the used to draw it, and the fill brush.
The location of the rectangle is set to the location of the current .
The dimensions of the ellipse used to draw the rounded corners are set
to 5% of the corresponding rectangle's dimensions.
The width of the rectangle.
The height of the rectangle.
The used to draw the rectangle.
The brush used to fill the rectangle.
Initializes a new instance of the class,
assigning the location and the size of the rectangle.
The dimensions of the ellipse used to draw the rounded corners are set
to 5% of the corresponding rectangle's dimensions.
The X coordinate of the rectangle, relative to the current object's location.
The Y coordinate of the rectangle, relative to the current object's location.
The width of the rectangle.
The height of the rectangle.
Initializes a new instance of the class,
assigning the location and the size of the rectangle,
and the used to draw it.
The dimensions of the ellipse used to draw the rounded corners are set
to 5% of the corresponding rectangle's dimensions.
The X coordinate of the rectangle, relative to the current object's location.
The Y coordinate of the rectangle, relative to the current object's location.
The width of the rectangle.
The height of the rectangle.
The used to draw the rectangle.
Initializes a new instance of the class,
assigning the location and the size of the rectangle,
the used to draw it, and the fill color.
The dimensions of the ellipse used to draw the rounded corners are set
to 5% of the corresponding rectangle's dimensions.
The X coordinate of the rectangle, relative to the current object's location.
The Y coordinate of the rectangle, relative to the current object's location.
The width of the rectangle.
The height of the rectangle.
The used to draw the rectangle.
The color used to fill the rectangle.
Initializes a new instance of the class,
assigning the location and the size of the rectangle,
the used to draw it, and the fill brush.
The dimensions of the ellipse used to draw the rounded corners are set
to 5% of the corresponding rectangle's dimensions.
The X coordinate of the rectangle, relative to the current object's location.
The Y coordinate of the rectangle, relative to the current object's location.
The width of the rectangle.
The height of the rectangle.
The used to draw the rectangle.
The brush used to fill the rectangle.
Initializes a new instance of the class,
assigning the location, size and roundness of the rectangle,
the used to draw it, and the fill color.
The X coordinate of the rectangle, relative to the current object's location.
The Y coordinate of the rectangle, relative to the current object's location.
The width of the rectangle.
The height of the rectangle.
The width of the ellipse used to draw the rounded corners (may be specified as "5%width" for example).
The height of the ellipse used to draw the rounded corners (may be specified as "5%height" for example).
The used to draw the rectangle.
The color used to fill the rectangle.
Initializes a new instance of the class,
assigning the location, size and roundness of the rectangle,
the used to draw it, and the fill brush.
The X coordinate of the rectangle, relative to the current object's location.
The Y coordinate of the rectangle, relative to the current object's location.
The width of the rectangle.
The height of the rectangle.
The width of the ellipse used to draw the rounded corners (may be specified as "5%width" for example).
The height of the ellipse used to draw the rounded corners (may be specified as "5%height" for example).
The used to draw the rectangle.
The brush used to fill the rectangle.
Gets the object describing the geometric rectangle
represented by the current object.
The coordinates of the rectangle are relative to the left top corner
of the current object.
Defines a value which can be in one of three states: undefined, true or false.
The value is undefined.
The value is true.
The value is false.
Enumerates the sizing modes of a .
At table level, default is for rows,
and for columns;
at row/column level, default inherits from the table.
Size (height for rows, width for columns) should be explicitly
specified (if omitted, it is determined by the available space
and row/column count).
Size (height for rows, width for columns) is calculated
automatically based on the content.
Enumerates the possible handling of a cell's content
when the cell is split between pages.
The content of a cell should be split if the cell is split.
The content of a cell should be copied each time the cell is split.
The content of a cell should be printed just once,
and cut if the cell is split and not all content fits.
Enumerates page break options available for elements of a .
A page break may be inserted if needed.
A page break is always inserted.
If a page break is needed, it should be inserted here.
A page break cannot be inserted.
The abstract base class for rows and columns of a .
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Assigns (copies) properties from another to the current object.
(The property is not copied.)
The source object to copy properties from.
Gets the object containing the current vector.
Gets the object containing the current vector.
Gets the 0-based index of the current vector in the containing
(i.e. the row index for rows, the column index for columns).
In tables, elements (cells, rows and columns)
are physically created only if they contain data, or if their style differs from default.
Hence the physical position of a object (i.e. a row or a column)
in the containing (accessible via the vector's
property) is not the same as the logical index of that row or column
in the table. The Ordinal property allows to retrieve that logical position.
Gets or sets the size of the current vector
(height if the vector is a ,
width if the vector is a ).
Gets or sets a value determining how page breaks are inserted before
the current vector
(regular, horizontal page breaks if the vector is a ,
vertical page breaks if the vector is a ).
Gets or sets a value determining how the current vector is treated
when it is too high (if it is a row) or too wide (if it is a column)
to fit in the vertical or horizontal space available on the current page.
Gets or sets a value indicating whether the current vector
(row or column) can split between pages.
The default value is false.
Gets or sets a value indicating whether the current vector
(row or column) is visible.
Gets the of the current vector (row or column).
Gets the of objects contained in the cells
of the current vector (row or column).
See for details.
Gets or sets a value determining
how the size of the current vector (height for rows, width for columns)
is calculated.
Describes how the height of a row in a
can be adjusted if required by adjustments to the height of the
containing table.
The behavior depends on the property
of the containing .
The row can be stretched as needed.
The row cannot be stretched.
The row can be stretched if it is the last row on the page.
Represents a row of a .
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets the containing the current row.
Gets or sets the height of the current row.
Gets or sets the mode of the current row.
Gets the at the specified column index.
This property always returns a non-null object.
The index of the cell in the current row (i.e. the column index).
The cell at the specified index.
Describes how the width of a column in a
can be adjusted if required by adjustments to the width of the
containing table.
The behavior depends on the property
of the containing .
The column can be stretched as needed.
The column cannot be stretched.
The column can be stretched if it is the last row on the page.
Represents a column of a .
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets the containing the current column.
Gets or sets the width of the current column.
Gets or sets the mode of the current column.
Gets the at the specified row index.
This property always returns a non-null object.
The index of the cell in the current column (i.e. the row index).
The cell at the specified index.
The abstract base class representing a collection of objects.
This is the base class for collections of table rows and columns,
accessible as and
on a .
Returns the size (height for rows, width for columns) of a
(row or column) identified by its index in a .
This method does not create the specified vector if it has not been initialized
(see remarks for details).
The 0-based index () of the row or column.
The height or width of the row or column.
Because elements of a 's collections (cells, rows and columns)
are physically created "on demand" only when they are accessed via collections'
indexer properties, using this method is more efficient when you only need
to test the height/width of a row/column without creating it.
For instance, the following code physically creates a object
before testing its height:
RenderTable rt = new RenderTable();
if (rt.Rows[10].Height == Unit.Auto)
doSomething();
At the same time, the following code does not cause a physical row object to be created,
while being functionally identical to the code above:
RenderTable rt = new RenderTable();
if (rt.Rows.GetVectorSize(10) == Unit.Auto)
doSomething();
Returns the value of the property of a
(row or column) identified by its index in a .
This method does not create the specified vector if it has not been initialized yet
(see remarks in for details).
The 0-based index () of the row or column.
The value of the specified vector's property,
or false if the vector has not been initialized.
Returns the value of the property of a
(row or column) identified by its index in a .
This method does not create the specified vector if it has not been initialized yet
(see remarks in for details).
The 0-based index () of the row or column.
The value of the specified vector's property,
or true if the vector has not been initialized.
Returns the value of the property of a
(row or column) identified by its index in a .
This method does not create the specified vector if it has not been initialized yet
(see remarks in for details).
The 0-based index () of the row or column.
The value of the specified vector's property,
or if the vector has not been initialized.
Returns the effective of a
(row or column) identified by its index in a .
This method does not create the specified vector if it has not been initialized yet
(see remarks in for details).
The 0-based index () of the row or column.
The effective sizing mode of the specified vector (row or column).
Inserts a range of rows or columns into the containing .
The position where to insert rows or columns.
The number of rows or columns to insert.
Deletes a range of rows or columns from the containing .
The index of the first row or column to delete.
The number of rows or columns to delete.
Deletes a row or column from the containing .
The index of the row or column to delete.
Inserts a row or column into the containing .
The position where to insert the row or column.
Gets the object containing the current collection.
Gets the object representing
the groups of vectors (rows or columns) defined on the current collection.
Gets or sets the logical count of vectors (rows or columns) in the current collection.
Setting this property to -1 (which is the default) ensures that Count
is calculated automatically.
tables are logically infinite. Simply accessing an element
at any position expands the table to include that position. Hence by default the Count
property returns the maximum row or column number that has been accessed so far.
Assigning a non-negative value to this property allows to increase or decrease the number of rows or columns
(if the number of vectors is decreased, elements with greater indices are cleared).
Gets the physical count of vectors (rows or columns)
currently stored in this .
Represents a collection of rows (objects of the type)
in a .
Returns the with the specified index
(the of the row),
or null if that object
has not been initialized.
The 0-based index of the row in the containing table.
The object or null.
Physically, rows in a are created
when they are accessed using the indexer property on the
collection. This method may be used
to test whether a physical object exists
for a particular row index.
Gets the collection of row groups defined on the containing .
Gets the object corresponding to the row
at the specified index in the containing .
Note that a will be created if it has not been
initialized for that row index yet.
Use to get a row without creating it.
The row index in the containing table.
The at the specified index in the table.
Represents a collection of columns (objects of the type)
in a .
Returns the with the specified index
(the of the column),
or null if that object
has not been initialized.
The 0-based index of the column in the containing table.
The object or null.
Physically, columns in a are created
when they are accessed using the indexer property on the
collection. This method may be used
to test whether a physical object exists
for a particular column index.
Gets the collection of column groups defined on the containing .
Gets the object corresponding to the column
at the specified index in the containing .
Note that a will be created if it has not been
initialized for that column index yet.
Use to get a column without creating it.
The column index in the containing table.
The at the specified index in the table.
Represents a cell in a .
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Assigns (copies) properties from another to the current object.
The and properties
are not copied.
A "deep" copy of the is made, i.e. a copy
of the is created and assigned to the
newly created cell's property.
The source object to copy properties from.
Determines whether the current cell is visible in the containing table.
A cell is visible if it spans at least one visible row and column
(see ).
true if the current cell is visible, false otherwise.
Gets or sets arbitrary data associated with the current cell.
Gets the containing the current cell.
Gets the containing the current cell.
Gets the 0-based index in the table of the row containing the current cell.
Gets the 0-based index in the table of the column containing the current cell.
Gets or sets the number of columns spanned by the current cell.
Cannot be less than 1, which is the default.
Gets or sets the number of rows spanned by the current cell.
Cannot be less than 1, which is the default.
Gets the index of the last column spanned by the current cell.
If is 1, the value of this property is equal to .
Gets the index of the last row spanned by the current cell.
If is 1, the value of this property is equal to .
Gets or sets the contained in the current cell.
Gets or sets the text contained in the current cell.
Setting this property checks the current value of the property.
If it is a , the is assigned to that object's
.
Otherwise, a new initialized with
is created and assigned to .
Note that properties from the old are copied
to the newly created using the
method.
In particular, this copies the style from the old object to the new one.
Getting this property returns of
assigned to the on the current cell, or an empty string
if the current value of is not a .
Gets or sets the image contained in the current cell.
Setting this property checks the current value of the property.
If it is a , the is assigned to that object's
.
Otherwise, a new initialized with
is created and assigned to .
Note that properties from the old are copied
to the newly created using the
method.
In particular, this copies the style from the old object to the new one.
Getting this property returns of
assigned to the on the current cell, or null
if the current value of is not a .
Gets the contained in the current cell.
Getting this property checks the current value of the property.
If it is a , it is returned.
Otherwise, a new is created, assigned to ,
and returned.
Note that properties from the old are copied
to the newly created using the
method.
In particular, this copies the style from the old object to the new one.
Gets the of the current cell.
The value of this property affects both ambient and non-ambient
style attributes of the cell itself and, through object containment,
ambient attributes of the cell's content.
For example, because is ignored
for table cells, the following code does not affect the look of a table:
RenderTable rt = new RenderTable();
rt.Cells[1, 2].Text = "My text.";
rt.Cells[1, 2].Style.Spacing.All = "3mm";
while the following code adds 3mm of whie space around the text in the
cell:
RenderTable rt = new RenderTable();
rt.Cells[1, 2].Text = "My text.";
rt.Cells[1, 2].CellStyle.Spacing.All = "3mm";
Gets the that is used to render the content of the current cell.
This style is not applied to the current cell itself,
rather it is applied to the cell's content (),
affecting both ambient and non-ambient style attributes of that object.
For an example, see remarks in .
Gets a describing the geometry of the current cell in the table.
The location of the returned rectangle defines the location (column and row) of the current cell,
while its size defines the number of columns and rows spanned by the current cell.
Gets or sets a value indicating how the content of the current cell is treated
when the cell is split vertically between two horizontal (extension,
created when the document is too wide) pages.
( should be true for this to happen).
Gets or sets a value indicating how the content of the current cell is treated
when the cell is split horizontally between two vertical (regular) pages
( should be true for this to happen).
Gets or sets a value indicating whether horizontal gridlines should
be drawn when the cell is split between two vertical (regular) pages.
Gets or sets a value indicating whether vertical gridlines should
be drawn when the cell is split between two horizontal (extension,
created when the document is too wide) pages.
Represents a collection of cells
(objects of the type ).
A collection of this type is returned by the property
of a table.
Returns the object at the specified row and column in the containing ,
or null if that object has not been initialized.
The 0-based row index of the cell.
The 0-based column index of the cell.
The object at the specified row and column, or null.
The cells of a table are not initialized unless they are accessed via the indexer property
on the cells collection. Unlike the indexer, this method can be used to test whether
a object has been created for a cell, without initializing it.
Gets the bounds of the initialized cells area.
The returned structure's
contains the column index of the rightmost initialized cell + 1,
while
contains the row index of the bottommost initialized cell + 1.
The size of the initialized cells area.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets the containing the current collection of cells.
Gets the at the intersection of the specified row and column.
This property always returns a non-null object.
The 0-based row index.
The 0-based column index.
The cell at the intersection of the specified row and column.
Flags specifying how a table header is repeated in a .
This is the type of .
The header is printed once at the top of the table.
The header is repeated at the top of each page. If there are multiple columns
per page, the header is repeated only at the top of the first column on the page.
The header is repeated only if there are multiple columns per page, at the top
of each column except the first on the page. If there is only one column,
the header is not printed at all.
The header is repeated at the top of all pages. If there are multiple columns per page,
the header is repeated at the top of each column.
Flags specifying how a table footer is repeated in a .
This is the type of .
The footer is printed once at the end of the table.
The footer is repeated at the bottom of each page. If there are multiple columns
per page, the footer is repeated only at the bottom of the last column on the page.
The footer is repeated only if there are multiple columns per page, at the bottom
of each column except the last on the page. If there is only one column,
the footer is not printed at all.
The footer is repeated at the bottom of all pages. If there are multiple columns per page,
the footer is repeated at the bottom of each column.
Represents a group of rows or columns
(see and ).
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets the containing the current group.
Gets the containing the current group.
Gets the 0-based index in the containing
of the first row or column in the current group.
Gets the number of rows or columns in the current group.
Gets the 0-based index in the containing
of the last row or column in the current group.
Gets or sets a value determining how the current group is treated
when it is too high (if it is a group of rows) or too wide (if it
is a group of columns) to fit in the vertical or horizontal space
available on the current page.
The default value is .
Gets or sets a value indicating whether the current group can split between pages.
The default is true.
Gets or sets a value indicating whether the current group
should be repeated as a table header on each page where
the containing table is printed.
Only one row and column group in a table can has this property set to true.
Gets or sets a value indicating whether the current group
should be repeated as a table footer on each page where
the containing table is printed.
Only one row and column group in a table can has this property set to true.
Gets or sets a value indicating whether the current group
should be repeated as a table header on each column where
the containing table is printed.
Only one row and column group in a table can has this property set to true.
Gets or sets a value indicating whether the current group
should be repeated as a table footer on each column where
the containing table is printed.
Only one row and column group in a table can has this property set to true.
Gets or sets flags indicating whether the current group
should be treated as a table header repeated on each
page and/or column.
Gets or sets flags indicating whether the current group
should be treated as a table footer repeated on each
page and/or column.
Gets or sets the minimum number of rows or columns that must be printed
on the same page before the current group, to allow a page break to be inserted.
Gets or sets the minimum number of rows or columns that must be printed
on the same page after the current group, to allow a page break to be inserted.
Gets the associated with the current group.
This style affects ambient and non-ambient attributes of the group as a whole,
and ambient properties of the elements contained in the group.
Gets the that is used to initialize
of cells in the current group.
Gets an instance of class representing the
data binding properties of the current table row/column group.
This property always returns a object,
initializing it if if has not been initialized yet.
Use to test whether the current group
is data bound without initializing .
Gets or sets an array of table vectors' (rows or columns) ordinals
that will span over the whole group.
This property is used only in databound tables, and allows to specify
the number of vectors in which the cells will be merged for the current
vector group.
Gets a value indicating whether the current row/column group is data bound.
Returns true if the group's property
has been initialized and its is not .
Gets a combination of flags
specifying the data binding mode of the current row/column group.
Represents a collection of row or column groups in a .
This is the type of and
collections.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets the group of rows or columns which has the
property set to true.
The which is a table header repeated on each page,
or null if such group does not exist.
Gets the group of rows or columns which has the
property set to true.
The which is a table footer repeated on each page,
or null if such group does not exist.
Gets the group of rows or columns which has the
property set to true.
The which is a table header repeated on each column,
or null if such group does not exist.
Gets the group of rows or columns which has the
property set to true.
The which is a table footer repeated on each column,
or null if such group does not exist.
Gets the bound of the current group collection,
i.e. the index of the last row or column in the contained groups plus 1.
The bound of the current group collection.
Searches the current collection for a group with the specified
position (row or column index) in the containing table, and count of elements.
The starting position (row or column index) of the group in the containing table.
The count of rows or columns in the group.
The group matching the search criteria, or null if such group does not exist.
Searches the current collection for all groups that contain
the row or column with the specified index in the containing table,
returns the array of all groups that were found.
The row or column index.
The array of objects that were found.
Gets the containing the current collection of row or column groups.
Gets the row or column group that has the specified position in the containing table and element count.
This property always returns a object. If the group with the specified
parameters did not exist, it is created and added to the current collection.
The index in the containing table of the first row or column in the group.
The number of rows or columns in the group.
The with the specified criteria.
Gets a value indicating whether at least one group
in the current collection of row/column groups is data bound.
Gets a combination of flags
specifying the data binding mode of the current collection of row/column groups.
This property returns:
- if no groups in the collection are data bound;
- if at least one group in the collection is data bound.
Represents a (possibly sparse) user-defined group of cells
(objects of type ) in a .
Initializes a new instance of the class,
includes a range of cells identified by a rectangular area, in the group.
Identifies a rectangluar range of cells as follows:
- range.X is the column index of the top left cell;
- range.Y is the row index of the top left cell;
- range.Width is the number of columns;
- range.Height is the number of rows.
Initializes a new instance of the class,
includes a single cell identified by its coordinates, in the group.
Identifies a cell as follows:
- cell.X is the column index of the cell;
- cell.Y is the row index of the cell.
Initializes a new instance of the class,
includes a range of cells identified by a list of rectangular areas, in the group.
The list of rectangular areas to include in the group,
each area is identified by a structure as follows:
- is the column index of the top left cell;
- is the row index of the top left cell;
- is the number of columns;
- is the number of rows.
Initializes a new instance of the class,
includes a range of cells identified by a list of cell coordinates, in the group.
The list of cell coordinates to include in the group,
each cell is identified by a structure as follows:
- is the column index of the cell;
- is the row index of the cell.
Initializes a new instance of the class,
includes a range of cells identified by a list of rectangular areas or individual cell coordnates, in the group.
The list of rectangular areas or individual cell coordnates to include in the group,
each item in the list may be either a or a structure.
If the item is a , it identifies an area to include as follows:
- is the column index of the top left cell;
- is the row index of the top left cell;
- is the number of columns;
- is the number of rows.
If the item is a , it identifies a cell to include as follows:
- is the column index of the cell;
- is the row index of the cell.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Tests whether the current cell group contains a cell with the specified row and column indices.
The row index of the cell.
The column index of the cell.
true if the current group contains the specified cell, false otherwise.
Gets the containing the current cell group.
Gets the containing the current cell group.
Gets the of the current cell group.
Gets the of objects contained in the cells
of the current cell group.
See for details.
Gets an array of structures identifying all cells
included in the current group.
For details,
(lone cells are represented by rectangles with both dimensions set to 1).
Represents a collection of objects.
This is the type of the property of a .
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Adds a to the current collection.
The user cell group to add.
The index of the newly added group in the current collection.
Finds all user cell groups (objects of type )
that contain the cell at the specified row and column indices.
The row index of the cell.
The column index of the cell.
A containing all objects from the current collection
that contain the cell at the specified position in the table.
Gets the bounding rectangle that includes all cells in all groups in the current collection.
A structure, the of which contains the column index + 1
of the rightmost cell, while the contains the row index + 1
of the bottommost cell.
Gets the object containing the current collection of user cell groups.
Gets the at the specified index in the current collection.
The index in the current collection.
The at the specified index.
Enumerates the modes of stretching the rows or columns of a
when filling an empty space below or on the right of the table.
Rows or columns of a table do no stretch.
All rows or columns of a table are stretched equally to fill the page.
All columns of a table are stretched equally to fill the page.
Only the last row or column on a page is stretched to fill it.
Only the last column on a page is stretched to fill it.
Represents a table in a .
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the row and column counts
(see ).
The count assigned to on the collection.
The count assigned to on the collection.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether rows, columns, cells, row, column and user cell groups should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Gets or sets a value determining how the heights of table rows are
calculated. The default is .
Gets or sets a value determining how the widths of table columns are
calculated. The default is .
To make a table with automatically calculated columns' widths,
set this property to ,
and the on the
to , e.g.:
RenderTable rt = new RenderTable();
rt.ColumnSizingMode = TableSizingModeEnum.Auto;
rt.Width = Unit.Auto;
Gets the collection of rows of the current .
Getting a row with an arbitrary index on this collection
always returns a object, initializing it if necessary.
Gets the collection of columns of the current .
Getting a column with an arbitrary index on this collection
always returns a object, initializing it if necessary.
Gets the collection of row groups defined on the current .
Gets the collection of column groups defined on the current .
Gets the collection of cells of the current .
Getting a cell with arbitrary row and column indices on this collection
always returns a object, initializing it if necessary.
Gets the collection of objects defined on the current table.
Obsolete. Use instead.
Gets or sets the mode of stretching the columns of the current table
when filling an empty space on the right of the table.
Gets or sets the mode of stretching the rows of the current table
when filling an empty space below the table.
Gets the of objects contained in the cells
of the current table.
See for details.
Gets or sets a value indicating whether a vertical page header, if defined (see remarks),
should be printed on the first of the horizontal pages spanned by the current table.
To define a vertical page header, create a column group on the current table,
and mark it as a page or column header, e.g. like this:
RenderTable rt = new RenderTable();
rt.ColGroups[0, 2].Header = TableHeaderEnum.All;
Gets or sets a value indicating whether a horizontal page header, if defined (see remarks),
should be printed on the first of the pages spanned by the current table.
To define a horizontal page header, create a row group on the current table,
and mark it as a page or column header, e.g. like this:
RenderTable rt = new RenderTable();
rt.RowGroups[0, 2].Header = TableHeaderEnum.All;
Gets or sets a value indicating whether a vertical page footer, if defined (see remarks),
should be printed on the last of the horizontal pages spanned by the current table.
To define a vertical page footer, create a column group on the current table,
and mark it as a page or column footer, e.g. like this:
RenderTable rt = new RenderTable();
rt.ColGroups[10, 2].Footer = TableFooterEnum.All;
Gets or sets a value indicating whether a horizontal page footer, if defined (see remarks),
should be printed on the last of the pages spanned by the current table.
To define a horizontal page footer, create a row group on the current table,
and mark it as a page or column footer, e.g. like this:
RenderTable rt = new RenderTable();
rt.RowGroups[10, 2].Footer = TableFooterEnum.All;
Gets or sets a value indicating whether vertical gridlines (see )
should be drawn when the current table is split between two or more horizontal (extender) pages.
Gets or sets a value indicating whether horizontal gridlines (see )
should be drawn when the current table is split between two or more pages.
Gets or sets a value determining how a table row is treated
when it is too high to fit in the vertical space available on the current page.
(you can override this value for individual rows using
property).
The default is .
Gets or sets a value indicating whether table rows can split between
pages (you can override this value for individual rows using
property). The default is false.
Gets or sets a value determining how a table column is treated
when it is too wide to fit in the horizontal space available on the current page.
(you can override this value for individual columns using
property).
The default is .
Gets or sets a value indicating whether table columns can split between
pages (you can override this value for individual columns using
property). The default is false.
Gets a combination of flags
specifying the data binding mode of the current object.
Takes into consideration data binding of row and column groups.
Represents a run of text in a .
Text is drawn using a single style (see for multi-style text).
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the property.
A string assigned to the property.
Initializes a new instance of the class,
assigning the property and style.
A string assigned to the property.
A to use
(the method
is used to copy the specified style to the current object's ).
Initializes a new instance of the class,
assigning the property and font.
A string assigned to the property.
The font used to render the text.
Initializes a new instance of the class,
assigning the property,
font and text color.
A string assigned to the property.
The font used to render the text.
The text color used to render the text.
Initializes a new instance of the class,
assigning the property,
font, text color and alignment.
A string assigned to the property.
The font used to render the text.
The text color used to render the text.
The horizontal text alignment.
Initializes a new instance of the class,
assigning the property,
font and text alignment.
A string assigned to the property.
The font used to render the text.
The horizontal text alignment.
Initializes a new instance of the class,
assigning the property,
and text alignment.
A string assigned to the property.
The horizontal text alignment.
Initializes a new instance of the class,
assigning the property,
and the parent styles.
A string assigned to the property.
The style assigned to the property of the current object's style.
The style assigned to the property of the current object's style.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
Gets or sets the text of the current object.
Gets a value indicating whether the property of the current object is
not null and has a greater than zero length.
Gets the length of the string returned by the property.
Specifies the text alignment on a tab position.
See for details.
Text is left-aligned on the tab position (text starts at the tab stop).
Text is centered around the tab position.
Text is right-aligned on the tab position (text ends at the tab stop).
Represents a tab stop in a text in a .
To set a tab stop, add it to the
collection on the text or paragraph.
Initializes a new instance of the class,
at the specified position, with the default () text alignment.
The tab position, relative to the left edge of the text area.
Initializes a new instance of the class,
at the specified position and with the specified text alignment.
The tab position, relative to the left edge of the text area.
The text alignment at this tab position.
Initializes a new instance of the class,
at the specified position and with the specified text alignment and fill character.
The tab position, relative to the left edge of the text area.
The text alignment at this tab position.
The character used to fill the area between the preceding and the current tab stops.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets the tab stop position, relative to the left of the text area.
The tab stop position is relative to the left edge of the text area.
That area does not include any padding or borders, so for example
if a has a 1 inch left padding,
and the first is set to 1 inch,
any text after the first tab char will be positioned 2 inches
to the right of the 's X coordinate.
Gets or sets the text alignment at the current tab.
Gets or sets the char used to fill the space between the current and the preceding tabs.
This feature's main use is in , where it fills the space
between left-aligned TOC entries and right-aligned page numbers.
Represents a collection of objects.
This is the type of property.
Creates a new object,
initializes it with the specified tab stop position,
and adds it to the current collection.
The position of the tab stop relative to the left edge of the text area.
The index of the added object in the current collection.
Creates a new object,
initializes it with the specified tab stop position and text alignment,
and adds it to the current collection.
The position of the tab stop relative to the left edge of the text area.
The text alignment at the specified tab stop.
The index of the added object in the current collection.
Creates a new object,
initializes it with the specified tab stop position, text alignment and fill char,
and adds it to the current collection.
The position of the tab stop relative to the left edge of the text area.
The text alignment at the specified tab stop.
The fill char between the preceding and the added tab stop.
The index of the added object in the current collection.
Adds a object to the current collection.
The object to add.
The index of in the current collection.
Inserts a object at the specified position into the current collection.
The index at which to insert .
The object to insert.
Removes a object from the current collection.
The object to remove.
Gets the index of a object in the current collection.
The object to get the index of.
The index of in the current collection.
Gets or sets the at the specified index.
The index in the current collection.
The TabPosition at the specified index.
Represents a single entry in the table of contents (TOC; ) in a .
Initializes a new instance of the class.
Gets the object containing the current TOC entry.
Gets a value indicating whether the current TOC entry will produce visible
output in the generated document.
Gets the count of characters in the current TOC entry.
Gets or sets the level of the current entry in the TOC.
This value is 1-based, and determines the indentation of the current item in the generated TOC.
The default value is 1, which does not indent the entry.
Nested levels are indented by the amount.
Represents a table of contents (TOC) in a .
Individual TOC entries are represented by objects.
This object may also contain other types of render objects
(this may be used e.g. to show a TOC header).
Initializes a new instance of the class.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Creates a new initialized with the specified
text and hyperlink, and adds it to the current TOC.
A text representing the TOC item that is being added.
A which is the target of the TOC item.
The that was created and added to the current TOC.
Creates a new initialized with the specified
text, hyperlink and level, and adds it to the current TOC.
A text representing the TOC item that is being added.
A which is the target of the TOC item.
The of the TOC item.
The that was created and added to the current TOC.
Creates a new initialized with the specified
text and target page number, and adds it to the current TOC.
A text representing the TOC item that is being added.
The page number which is the target of the TOC item.
The that was created and added to the current TOC.
Creates a new initialized with the specified
text, target page number and level, and adds it to the current TOC.
A text representing the TOC item that is being added.
The page number which is the target of the TOC item.
The of the TOC item.
The that was created and added to the current TOC.
Creates a new initialized with the specified
text and target , and adds it to the current TOC.
A text representing the TOC item that is being added.
A which is the target of the TOC item.
The that was created and added to the current TOC.
Creates a new initialized with the specified
text, target and level, and adds it to the current TOC.
A text representing the TOC item that is being added.
A which is the target of the TOC item.
The of the TOC item.
The that was created and added to the current TOC.
Creates a new initialized with the specified
text and target , and adds it to the current TOC.
A text representing the TOC item that is being added.
A which is the target of the TOC item.
The that was created and added to the current TOC.
Creates a new initialized with the specified
text, target and level, and adds it to the current TOC.
A text representing the TOC item that is being added.
A which is the target of the TOC item.
The of the TOC item.
The that was created and added to the current TOC.
Gets or sets a value indicating whether page numbers should be displayed in the current TOC.
Gets or sets a value indicating whether page numbers should be right-aligned within the current TOC.
Gets or sets a value indicating whether only the page numbers in the
rendered TOC represent clickable hyperlinks (otherwise, the entire
area between an entry's caption and page number can be clicked).
The default value is false.
Gets or sets a character used to fill empty spaces between TOC items and corresponding page numbers.
Gets or sets the indentation step of TOC items.
Items with equal to 1 are not indented,
each next level is indented by this value.
The default value is 10mm.
Represents a run of vertical text in a .
Designed primarily for rendering of Asian (e.g. Japanese) text in the traditional manner,
vertically from right to left.
Text is drawn using a single style (see for multi-style text).
The default height and width of is auto.
In particular, that means that text without line breaks will by default stretch
downwards indefinitely. To make text wrap at the bottom, the height of
the object must be explicitly set.
Note that while the main use of this class is to output text in Asian languages, you can also
print English text in this manner. To do so, add hex code 0xFEE0 to each English letter.
The code below prints "CASINO ROYAL" and digits "12345" vertically:
private static string ToVertical(string s)
{
StringBuilder sb = new StringBuilder(s.Length);
for (int i = 0; i < s.Length; i++)
if (s[i] == ' ')
sb.Append(s[i]);
else
sb.Append((char)((int)s[i] + (0xFF10 - (int)'0')));
return sb.ToString();
}
private C1PrintDocument CreateDocument()
{
C1PrintDocument doc = new C1PrintDocument();
doc.FontHandling = FontHandling.EmbedActualFonts;
RenderVerticalText rt;
rt = new RenderVerticalText();
rt.Style.Borders.All = LineDef.Default;
rt.Style.Font = new Font("Arial", 18);
rt.Text = ToVertical("CASINO ROYAL");
doc.Body.Children.Add(rt);
rt = new RenderVerticalText();
rt.Style.Borders.All = LineDef.Default;
rt.Style.Font = new Font("Arial", 18);
rt.Text = ToVertical("Digits: (12345)");
doc.Body.Children.Add(rt);
return doc;
}
Initializes a new instance of the class.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
Represents a paragraph of vertical text in a .
Paragraphs can contain inline text and images, possibly rendered using different styles.
The content of a paragraph is accessible via the property.
Designed primarily for rendering of Asian (e.g. Japanese) text in the traditional manner,
vertically from right to left.
The default height and width of is auto.
In particular, that means that text without line breaks will by default stretch
downwards indefinitely. To make text wrap at the bottom, the height of
the object must be explicitly set.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use.
Determines how item types are serialized
For internal use.
Forces the serializer to serialize the type name of a property or field.
For internal use.
This attribute defines additional properties for collections properties or fields.
For internal use.
For internal use.
For internal use.
Allows to mark field or property as "parent reference".
For internal use.
Allows to define additional properties for class.
For internal use.
For internal use.
For internal use.
Indicates that the object should be serialized only if it supports deserialization.
For internal use.
Indicates that the error occurs on deserialization value of this property should be ignored.
For internal use.
Indicates that the property or field is serializable only in C1D format.
For internal use.
Indicates that the property or field is serializable only in C1DX format.
For internal use.
Defines options for serialization in Open Xml format.
For internal use.
If defined then property/field will be ignored ONLY during serialization,
can be used to support backward compatibility.
For internal use.
For internal use only.
Represents an exception that occurred during C1DX or C1MDX serialization/deserialization
if the underlying zip stream has invalid format.
Abstract base class for and
classes.
Gets the list of strings describing the actions that lead to the exception that occurred
during serialization or deserialization.
Represents an exception that occurred during serialization.
Represents an exception that occurred during deserialization.
Gets the line number associated with the exception.
Gets the position in line associated with the exception.
For internal use.
Indicates the default white space handling.
Initializes a new instance of the Serializer class.
For internal use.
For internal use.
For internal use only.
Serializes the Brush class as XmlElement.
For internal use only.
Class with the only purpose in life - serialize images.
For internal use only.
For internal use only.
Class with the only purpose in life - serialize icons.
For internal use only.
For internal use only.
Class with the only purpose in life - serialize images.
For internal use only.
Specifies the alignment within their container of objects in the block flow
(see ).
This is the type of and
properties.
If specified for a child object's ,
indicates that the parent's value is used.
If specified for a , equivalent to
.
Objects are left-aligned for top to bottom flow (),
and top-aligned for left to right flow ().
Objects are centered horizontally for top to bottom flow (),
and vertically for left to right flow ().
Objects are right-aligned for top to bottom flow (),
and bottom-aligned for left to right flow ().
Specifies how to break words when lines of text wrap.
Default. A word is not split unless it is too long to fit within the boundaries of the container by itself.
A word can be split at any position if needed.
Specifies the horizontal alignment of text within a containing object.
This is the type of property.
The text is left-aligned.
The text is centered horizontally.
The text is right-aligned.
The text is justified horizontally by widening the white spaces existing in the text.
The text is justified horizontally by adding white spaces between all characters in the text.
(Note that if is false,
this mode is not supported, and is used instead.)
Specifies the vertical alignment of text within a containing object.
This is the type of property.
The text is top-aligned.
The text is centered vertically.
The text is bottom-aligned.
The text is justified vertically.
When applied to vertical text (, ),
justifies text vertically by adding white spaces between all characters.
(Note that if is false,
this mode is not supported, and is used instead.)
Specifies the horizontal alignment of foreground and background images.
This is the type of property
on and .
The image is left-aligned.
The image is centered horizontally.
The image is right-aligned.
Specifies the vertical alignment of foreground and background images.
This is the type of property
on and .
The image is top-aligned.
The image is centered vertically.
The image is bottom-aligned.
Specifies the subscript and superscript properties of text.
This is the type of property.
The text is positioned and sized normally.
The text is positioned and sized as subscript.
The text is positioned and sized as superscript.
Defines image alignment properties.
Gets or sets the horizontal alignment of an image within a container.
Gets or sets the vertical alignment of an image within a container.
Gets or sets a value indicating whether an image is stretched horizontally to fill its container.
Gets or sets a value indicating whether an image is stretched vertically to fill its container.
Gets or sets a value indicating whether the original aspect ratio is preserved when rendering an image.
Gets or sets a value indicating whether an image is tiled horizontally within its container.
Gets or sets a value indicating whether an image is tiled vertically within its container.
Gets or sets a value indicating whether an image should be resized to best fit within its container.
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Represents the alignment of an image within its container.
Initializes a new instance of the class.
A value assigned to .
A value assigned to .
A value assigned to .
A value assigned to .
A value assigned to .
A value assigned to .
A value assigned to .
Returns a string that represents the current .
A string that represents the current .
Gets or sets the horizontal alignment of an image within a container.
Gets or sets the vertical alignment of an image within a container.
Gets or sets a value indicating whether an image is stretched horizontally to fill its container.
Gets or sets a value indicating whether an image is stretched vertically to fill its container.
Gets or sets a value indicating whether the original aspect ratio is preserved when rendering an image.
Used when or is true.
Gets or sets a value indicating whether an image is tiled horizontally within its container.
Ignored if is true.
Gets or sets a value indicating whether an image is tiled vertically within its container.
Ignored if is true.
Gets or sets a value indicating whether an image should be resized to best fit within its container.
See remarks for details.
Getting this property returns a Boolean conjunction (AND) of the
, and values.
Setting this property to a true value sets
, and to true.
Setting this property to a false value sets
only to false.
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets the default image alignment.
A structure representing four values
corresponding to the four sides of a rectangluar area.
Used by and properties.
Describes four values
corresponding to the four sides of a rectangluar area.
Gets or sets the left offset value.
Gets or sets the top offset value.
Gets or sets the right offset value.
Gets or sets the bottom offset value.
Sets all four offset values.
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Initializes a new instance of the structure,
assigning the , , and
values.
A string representing the value assigned to the property.
A string representing the value assigned to the property.
A string representing the value assigned to the property.
A string representing the value assigned to the property.
Only absolute values (such as "1mm" or "8in") are allowed.
Initializes a new instance of the structure,
assigning a single value to all four offset properties.
A string representing the value assigned to all four offsets.
Only absolute values (such as "1mm" or "8in") are allowed.
Initializes a new instance of the structure,
assigning a single value to all four offset properties.
A value assigned to all four offsets.
Only absolute values (such as "1mm" or "8in") are allowed.
Gets or sets the left offset value.
Only absolute values (such as "1mm" or "8in") are allowed.
Gets or sets the top offset value.
Only absolute values (such as "1mm" or "8in") are allowed.
Gets or sets the right offset value.
Only absolute values (such as "1mm" or "8in") are allowed.
Gets or sets the bottom offset value.
Only absolute values (such as "1mm" or "8in") are allowed.
Sets all four offset values.
Only absolute values (such as "1mm" or "8in") are allowed.
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Represents a set of attributes used to draw lines.
This class is immutable.
Initializes a new instance of the class
with default values (1pt wide black line).
Initializes a new instance of the class,
assigning line color.
A value assigned to the property.
Initializes a new instance of the class,
assigning line width and color.
A value assigned to the property.
A value assigned to the property.
Initializes a new instance of the class,
assigning line width, color and dash style.
A value assigned to the property.
A value assigned to the property.
A value assigned to the property.
Initializes a new instance of the class,
assigning line width, color and dash pattern.
is set to .
A value assigned to the property.
A value assigned to the property.
A value assigned to the property.
Initializes a new instance of the class,
assigning line width, color, dash background color and dash style.
A value assigned to the property.
A value assigned to the property.
A value assigned to the property.
A value assigned to the property.
Initializes a new instance of the class,
assigning line width, color, dash background color and dash pattern.
is set to .
A value assigned to the property.
A value assigned to the property.
A value assigned to the property.
A value assigned to the property.
Tests whether the current and another objects define
same line styles - i.e. whether the values of ,
, and
properties are the same.
Note that this method does NOT compare the lines' widths.
A to compare to the current one.
true if the two lines have same styles, false otherwise.
Determines whether the specified object is equal to the current object.
This method compares the property values on the objects.
The object to compare with the current object.
true if the specified object's properties are equal to the current one's, false otherwise.
Serves as a hash function for the type.
A hash code for the current object.
Returns a string that represents the current object.
A string that represents the current object.
Creates a object, and initialises it with values
acquired by parsing a string representation of a .
A string representing a (see ).
If true, an exception is thrown if an error occurs while parsing; otherwise, errors are ignored.
The new object.
For internal use only.
Gets the line color.
Gets the line width (thickness).
Gets the the background color of spaces between the dashes of a dashed line.
Not used if is .
Gets the of the current .
Gets an array of custom dashes and spaces.
This property is used only if
is set to .
Represents an empty line (with emtpy color and zero width).
Represents the default regular line (solid black, 1pt wide).
Represents the default bold line (solid black, 2pt wide).
Used to convert objects of type.
Converts a string to a .
An that provides a format context.
The string to convert.
The converted object.
Converts an object to a string.
An that provides a format context.
The object to convert.
The converted string.
A structure defining the four borders around a rectangular area.
Each border is represented by a object.
Describes four borders around a rectangular area.
Each border is represented by a object.
Gets or sets the left border.
Gets or sets the top border.
Gets or sets the right border.
Gets or sets the bottom border.
Sets all four borders.
Gets or sets the width of the ellipse used to draw the rounded corners of the border.
Gets or sets the height of the ellipse used to draw the rounded corners of the border.
Gets a value indicating whether the current borders is rounded
(i.e. whether both and have non-zero values).
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the left border.
Gets or sets the top border.
Gets or sets the right border.
Gets or sets the bottom border.
Sets all four borders to a single value.
Gets or sets the x-radius of the ellipse used to draw the rounded corners of the border.
If both this and are non-zero, all borders are drawn using the
same () border thickness.
If this value is less than the border thickness, border thickness is used as the radius.
Gets or sets the y-radius of the ellipse used to draw the rounded corners of the border.
If both this and are non-zero, all borders are drawn using the
same () border thickness.
If this value is less than the border thickness, border thickness is used as the radius.
Gets a value indicating whether the current structure
defines rounded borders (i.e. whether both and
have non-zero values).
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
A structure defining the grid lines (four borders and two internal lines)
used to draw a .
Each line is represented by a object.
Describes the grid lines used to draw a .
Each line is represented by a object.
Gets or sets the left outer border of a table.
Gets or sets the top outer border of a table.
Gets or sets the right outer border of a table.
Gets or sets the bottom outer border of a table.
Gets or sets the vertical inner lines in a table.
Gets or sets the horizontal inner lines in a table.
Sets all six lines to a single value.
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the left outer border of a table.
Gets or sets the top outer border of a table.
Gets or sets the right outer border of a table.
Gets or sets the bottom outer border of a table.
Gets or sets the vertical inner lines in a table.
Gets or sets the horizontal inner lines in a table.
Sets all six lines to a single value.
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Represents the visual attributes of a hyperlink in a certain state.
Initializes a new instance of the class.
Checks whether the current has all default values.
true if all properties on the current object have default values, false otherwise.
Represents the visual attributes of a text hyperlink in a certain state.
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning background and foreground colors and property.
The background color of the hyperlink text.
The foreground color of the hyperlink text.
A value indicating whether the hyperlink text should be underlined.
Initializes a new instance of the class,
assigning property.
A value indicating whether the hyperlink text should be underlined.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Checks whether the current has all default values.
true if all properties on the current object have default values, false otherwise.
Determines whether the specified object is equal to the current object.
This method compares properties on the two objects.
The object to compare with the current object.
true if the specified Object is equal to the current object; otherwise, false.
Serves as a hash function for .
A hash code for the current object.
Gets the background color.
If this value indicates an empty or transparent color,
the background color of a hyperlink is not changed.
Gets the foreground (text) color.
If this value indicates an empty or transparent color,
the text color of a hyperlink is not changed.
Gets a value indicating whether the text of a hyperlink is underlined.
Gets the default attributes of visited hyperlinks.
Gets the default attributes of "normal" (neither visited nor highlighted) hyperlinks.
Gets the default attributes of highlighted hyperlinks.
Represents the shadow cast by a .
Represents the shadow cast by a .
This interface is implemented by structure.
Gets or sets the transparency of the shadow, in percent.
A value of 0 defines a solid (non-transparent) shadow,
a value of 100 (which is the default) defines a fully transparent (invisible) shadow.
Gets or sets the size of the shadow relative to the size of the object, in percent.
A value of 100 (which is the default) indicates that the shadow has the same size
as the object.
Gets or sets the distance that the shadow's center is offset from the the object's center.
Note that only absolute values (such as "0.5in" or "4mm") can
be assigned to this property.
The default is 2mm.
Gets or sets the angle, in degrees, of the shadow. The angle is measured relative
to the three o'clock position clockwise. The default is 45.
Gets or sets the color of the shadow. The default is Black.
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Initializes a new instance of the structure,
assigning , , and
values.
A value assigned to the property.
A value assigned to the property.
An absolute value assigned to the property.
A value assigned to the property.
A value assigned to the property.
Gets or sets the transparency of the shadow, in percent.
A value of 0 defines a solid (non-transparent) shadow,
a value of 100 defines a fully transparent (invisible) shadow.
Gets or sets the size of the shadow relative to the size of the object, in percent.
A value of 100 indicates that the shadow has the same size
as the object.
Gets or sets the distance that the shadow's center is offset from the the object's center.
Note that only absolute values (such as "0.5in" or "4mm") can
be assigned to this property.
Gets or sets the angle, in degrees, of the shadow. The angle is measured relative
to the three o'clock position clockwise.
Gets or sets the color of the shadow.
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Represents the style of an object.
Clears the current style, resets all properties so that they
inherit from the parent style.
Copies to the current style all properties of another object
that have been explicitly set on that other style,
plus the values of the and properties.
The source object to copy properties from.
Effectively, this method makes the current
a complete copy of the style.
Gets a value indicating whether the current style has calculated properties.
Gets the owner of the current style.
Gets or sets the that is the parent of the current style.
If non-null, that style provides the values for non-ambient properties
of the current style that have not been explicitly set.
If null, such properties have default values.
This property is null by default.
Initially a object does not have any
explicitly set properties. This means that the effective
values of all ambient properties (such as font) are inherited from
the style of the containing object, while the effective values
of all non-ambient properties (such as borders) are inherited
from the style specified by this property.
Sets both parents ( and ) to the same value.
Gets the collection of child styles
(i.e. objects that have their
set to the current style).
This method always returns a non-null collection of child styles,
initializing it if it did not exist.
To test whether a style already has child styles
without creating the collection,
use the property.
Gets a value indicating whether the current style's
collection has been initialized and contains one or more elements.
Gets or sets the that is the ambient parent of the current style.
If non-null, that style provides the values for ambient properties
of the current style that have not been explicitly set.
If null, such properties are inherited from the style of the containing object.
This property is null by default.
Initially a object does not have any
explicitly set properties. This means that the effective
values of all ambient properties (such as font) are inherited from
the style of the containing object, unless this property has
been set to a non-null value, in which case they are
inherited from that style.
Note that even if an AmbientParent has been specified,
only ambient properties that have been explicitly set on
that style or any of its own ambient parents (styles or containing objects)
propagate to the current style. See example below for details.
For instance, the following code:
C1PrintDocument doc = new C1PrintDocument();
RenderArea ra = new RenderArea();
ra.Style.FontBold = true;
RenderText rt = new RenderText("my text");
ra.Style.AmbientParent = doc.Style;
ra.Children.Add(rt);
doc.Body.Children.Add(ra);
still prints "my text" in bold, while this code:
C1PrintDocument doc = new C1PrintDocument();
doc.Style.FontBold = false; // this line makes the difference!
RenderArea ra = new RenderArea();
ra.Style.FontBold = true;
RenderText rt = new RenderText("my text");
ra.Style.AmbientParent = doc.Style;
ra.Children.Add(rt);
doc.Body.Children.Add(ra);
prints "my text" using regular (non-bold) font. This is because
has been explicitly set to false
on the style assigned to the AmbientParent on the text object.
Gets or sets the background image.
The image is aligned using .
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is no image.
Gets or sets the name of the background image
in on the current document.
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is emtpy string.
Gets or sets the brush used to fill the background.
If both this and properties are specified for a style,
the BackColor takes precedence.
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is no brush.
Gets or sets the text (foreground) color.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is black color.
Gets or sets the text rotation angle,
in degrees counterclockwise from the X axis.
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is 0.
Gets or sets the horizontal text alignment.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is left alignment.
Gets or sets the vertical text alignment.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is top alignment.
Gets or sets the line spacing of a text in percent.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is 100% (normal line spacing).
Gets or sets a value indicating whether text automatically
wraps to the next line when there is not enough space left on the current line.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is true.
Gets or sets a value indicating whether text is rendered
normally, or as superscript or subscript.
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is normal text.
Gets or sets a for "normal" (neither visited nor highlighted) hyperlinks.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is to highlight hyperlinks with blue text color.
Gets or sets a for visited hyperlinks.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is to highlight visited hyperlinks with magenta text color.
Gets or sets a for highlighted hyperlinks.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is to underline text on a hyperlinks under mouse.
Gets or sets a for active hyperlinks.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is to not highlight active hyperlinks.
Gets or sets a value indicating whether spaces at ends of text lines
are taken into account when measuring the text.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is false.
Gets or sets the padding (white space added between the style owner's content and borders).
Padding is within (if any), while is added outside of borders.
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is no padding.
Gets or sets the spacing between the the current style's owner and the surrounding objects.
Spacing is outside of (which, in turn, contain ).
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is no spacing.
Gets or sets the borders drawn around the current style's owner object.
Borders are drawn within the area, and contain .
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is no borders.
Gets or sets properties of the shadow cast by the current object.
By default the shadow is invisible due to being 100% transparent.
Set Shadow.Transparency to a value less than 100, to show shadow.
Other properties can be adjusted as needed.
Gets or sets the grid lines used to draw tables.
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is no grid lines.
Gets or sets the foreground image alignment.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is to align to left/top, stretch horizontally and vertically, and keep aspect ratio.
Gets or sets the background image alignment.
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is to align to left/top, stretch horizontally and vertically, and keep aspect ratio.
Gets or sets the background color.
If both this and properties are specified for a style,
this property takes precedence.
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is transparent background color.
Gets or sets the minimum number of orphan text lines allowed on a page
before or after a page break.
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is 0.
Gets or sets a value indicating whether just the client area of a ,
or the whole control, is rendered by the object owning the current style.
A can render an image of a
if it is assigned to the RenderImage's property.
ClientAreaOnly can be used to indicate that only the client area of that control should be rendered.
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is false.
Gets or sets the brush used to fill internal areas of shapes
(objects derived from ).
If for a style both this and are specified,
ShapeFillColor takes precedence.
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is no brush.
Gets or sets the color used to fill internal areas of shapes
(objects derived from ).
If for a style both this and are specified,
this property takes precedence.
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is transparent fill color.
Gets or sets the style of lines used to draw shape objects (RenderLine, RenderRectangle etc).
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is a black line, 1pt thick.
Gets or sets the alignment of the current style's owner object within its container in a block flow.
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is .
Gets or sets the alignment of children of the current style's owner object in a block flow.
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is .
Gets or sets the indentation of the first line in a block of text.
This property is non-ambient (inherited from the of the current style if not explicitly set).
The default is 0.
Gets or sets the spacing between characters in a text.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is 0 (normal spacing).
Gets or sets the amount (in percent) by which to increase or decrease
the widths of characters in a text.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is 100 (normal width).
Gets or sets a value indicating whether the last line of text should be justified
if the current style has set to
or .
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is false.
Gets or sets a value indicating whether lines of text
ending with a newline character should be justified
if the current style has set to
or .
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is true.
Gets or sets a value indicating how words can be split when text lines wrap.
This property is ignored if is false.
The default value is
Gets or sets the font.
Note that setting this property resets properies specifying individual font attributes:
,
,
,
,
and
.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is Arial, 10pt.
Gets or sets the face name of the font.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is Arial.
Gets or sets the em-size of the font.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is 10.
Gets or sets a value indicating whether the font is bold.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is false.
Gets or sets a value indicating whether the font is italic.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is false.
Gets or sets a value indicating whether the font is underlined.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is false.
Gets or sets a value indicating whether the font is strikeout.
This property is ambient (inherited from the style of the object containing the current style's owner if not explicitly set).
The default is false.
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Gets or sets the expression used to calculate .
Represents a collection of objects.
This is the type of the collection
on a .
Creates a new object and adds it to the current collection.
The created object.
Gets object owning this collection.
Gets the object at the specified index in the current collection.
The index of the element.
The element at the specified index.
Represents operating system related information in a .
Initializes a new instance of the class.
Note that the property values are not updated by this constructor,
the method should be used to actually
fill the current object with system info data.
Updates the properties of the current object
with the current system info data.
Gets the number of system screens.
Gets the logical horizontal resolution (DPI) of the screen.
Gets the logical vertical resolution (DPI) of the screen.
Gets the physical horizontal resolution (DPI) of the screen.
Gets the physical vertical resolution (DPI) of the screen.
Gets the bounds of the screen as returned by .
Gets the measurement device as returned by .
Gets the measurement printer name as returned by .
Gets the measurement resolution as returned by .
Gets the if is a printer,
or the word "Screen" if it is the screen.
Gets a string representing the format version used to serialize a .
Format versions are backward-compatible, but not necessarily forward-compatible.
Gets the assembly version of the assembly containing the class.
Gets the current culture.
Gets the OS version as returned by .
The abstract base class for system () and user defined () tags.
Gets the object containing the current tag.
Can return null if the tag has not been added to a document.
Gets or sets the value of the current tag.
The abstract base class for system defined tags such as and .
Gets the name of the current tag.
Sets the name of the current tag.
The new tag name.
Copies the properties of the specified object to the current object.
The source object to copy properties from.
Gets or sets the value of the current tag.
The abstract base class for system tags that evaluate to a page number or count.
Represents the current page number system tag.
Returns the name of the current tag ("PageNo").
"PageNo".
Represents the total page count system tag.
Returns the name of the current tag ("PageCount").
"PageCount".
Represents the current horizontal page number system tag.
Returns the name of the current tag ("PageX").
"PageX".
Represents the horizontal page count system tag.
Returns the name of the current tag ("PageXCount").
"PageXCount".
Represents the current vertical page number system tag.
Returns the name of the current tag ("PageY").
"PageY".
Represents the vertical page count system tag.
Returns the name of the current tag ("PageYCount").
"PageYCount".
Represents a system tag that is replaced by the page number of a hyperlink target.
Returns the name of the current tag ("HyperlinkPageNo").
"HyperlinkPageNo".
The abstract base class for system tags that return
data from .
Represents a system tag returning the date and time when the document was last generated.
Returns the name of the current tag ("GeneratedDateTime").
"GeneratedDateTime".
Represents a system tag returning the date and time when the document was last printed.
Returns the name of the current tag ("PrintedDateTime").
"PrintedDateTime".
Represents a system tag returning the file name last used to save or load the document.
Returns the name of the current tag ("LastFileName").
"LastFileName".
Represents a system tag returning the name of the printer last used to print the document.
Returns the name of the current tag ("LastPrinterName").
"LastPrinterName".
Represents a user-defined tag.
Initializes a new instance of the class with the specified name and value.
The name of the tag.
The value of the tag.
Initializes a new instance of the class with the specified name.
The name of the tag.
Initializes a new instance of the class with the specified name, value and type.
The name of the tag.
The value of the tag.
The type of the tag.
Sets the name of the current tag.
The new tag name.
Copies the properties of the specified object to the current object.
The source object to copy properties from.
Gets or sets a value indicating whether the of the current tag
should be serialized. The default is true.
Gets or sets a value indicating whether to show the current tag and
allow the user to edit its in the tags input dialog.
The default is true.
Gets or sets a value indicating whether the
property contains a string with a script expression
which must be evaluated when the tag is rendered.
Gets or sets the description of the tag.
If not empty, used as the label in the tag input dialog.
(If Description is empty, is shown in the input dialog instead.)
Gets or sets the current tag type.
Gets or sets the current tag value.
Gets or sets a object that is used by the tag input dialog
to customize the editor for the current tag. By default, this property is null.
The class is abstract, the following types derived from it
can be used, depending on the current tag's type:
- Used to customize input of a string value.
- Used to customize input of a value.
- Allows to use a or for input of the tag's value.
- Allows to input a Boolean value using a check box.
- Used to customize input of a numeric value.
Converts objects to/from other types.
Tests whether this converter can convert the object to the specified type.
An ITypeDescriptorContext that provides a format context.
The target type.
true if the conversion can be performed, false otherwise.
Converts the given value object to the specified type.
An ITypeDescriptorContext that provides a format context.
The culture into which will be converted.
The object to convert.
The target type.
An object representing the converted value.
Converts values to/from other types.
Converts the given object to a object.
An ITypeDescriptorContext that provides a format context.
The culture into which will be converted.
The object to convert.
An object representing the converted value.
Represents a collection of objects.
Initializes a new instance of the class.
Adds a object to the current collection.
The object to add.
The index of the newly added object.
Removes a object from the current collection.
The object to remove.
Finds the index of the object with the specified name in the collection.
The name to search for.
The index of the found object.
Gets or sets a in the current collection by its index.
The index of the in the current collection.
The with the specified index.
Gets a in the current collection by its .
The name of the .
The with the specified name.
The abstract base class for specialized classes used by the
tag input dialog to customize input of individual tags.
Initializes a new instance of the class.
Copies the properties of the specified object to the current object.
The source object to copy properties from.
Creates a copy of the current object.
The newly created object.
Returns a value indicating whether the input form should show the label with the tag's
description adjacent to the input control.
True if the label is to be shown, false otherwise.
Creates a control that can be used to input the tag value.
The tag to edit.
The maximum width of the control.
The newly created control.
Checks the value contained in the control.
The control used to enter the value.
The to which the value is to be assigned.
The error message, assigned if the check fails.
True if the value is valid, false otherwise.
Copies the value from the control to the tag.
The source control containing the value.
The to which the value is assigned.
Copies the value from the tag to the control.
The control to which the value is copied.
That source containing the value.
Represents customization parameters for input of string tag values.
Initializes a new instance of the class.
Initializes a new instance of the class.
The maximum length of the input string.
Copies the properties of the specified object to the current object.
The source object to copy properties from.
Creates a .
The tag to edit.
The maximum width of the control.
The newly created control.
Returns true.
The control used to enter the value.
The to which the value is to be assigned.
The error message, assigned if the check fails.
True.
Copies the value from the control to the tag.
The source control containing the value.
The to which the value is assigned.
Copies the value from the tag to the control.
The control to which the value is copied.
That source containing the value.
Gets or sets the maximum length of the input string.
Represents customization parameters for input of tag values.
Initializes a new instance of the class.
Initializes a new instance of the class.
The minimum allowed date.
The maximum allowed date.
The format to use in the date/time picker.
The custom date/time format string.
Initializes a new instance of the class.
The format to use in the date/time picker.
The custom date/time format string.
Copies the properties of the specified object to the current object.
The source object to copy properties from.
Creates a .
The tag to edit.
The maximum width of the control.
The newly created control.
Checks the value contained in the control.
The control used to enter the value.
The to which the value is to be assigned.
The error message, assigned if the check fails.
True if the value falls between the minimum and maximum allowable dates, false otherwise.
Copies the value from the control to the tag.
The source control containing the value.
The to which the value is assigned.
Copies the value from the tag to the control.
The control to which the value is copied.
That source containing the value.
Gets or sets the custom date/time format string.
Gets or sets the minimum allowed date.
Gets or sets the maximum allowed date.
Gets or sets the format to use in the date/time picker.
Specifies the type of list for .
The is used for input.
The is used for input.
Represents customization parameters for input of tag values that can be selected from a list.
Initializes a new instance of the class.
Initializes a new instance of the class.
The type of list input to use.
The collection of list items.
Copies the properties of the specified object to the current object.
The source object to copy properties from.
Creates a or a , depending on the of list input.
The tag to edit.
The maximum width of the control.
The newly created control.
Checks the value contained in the control.
The control used to enter the value.
The to which the value is to be assigned.
The error message, assigned if the check fails.
True if the value falls between the minimum and maximum allowable dates, false otherwise.
Copies the value from the control to the tag.
The source control containing the value.
The to which the value is assigned.
Copies the value from the tag to the control.
The control to which the value is copied.
That source containing the value.
Gets or sets the type of list input to use.
Gets the value indicating whether the list contains any items.
Gets the collection of list items.
Represents a list item for .
Initializes a new instance of the class.
The item name.
The item value.
Copies the properties of the specified object to the current object.
The source object to copy properties from.
Returns the string representation of the current .
The string representing the current item.
Gets or sets the current item's value.
Represents a collection of list items for .
Initializes a new instance of the class.
The collection owner.
Adds an item to the current collection.
The item to add.
The index of the newly added item.
Removes an item from the current collection.
The item to remove.
Gets or set the item with the specified index.
The index of the item.
The item with the specified index.
Gets or set the item with the specified name.
The name of the item.
The item with the specified name.
Represents customization parameters for input of Booleand tag values.
Initializes a new instance of the class.
Copies the properties of the specified object to the current object.
The source object to copy properties from.
Returns false.
False.
Creates a .
The tag to edit.
The maximum width of the control.
The newly created control.
Returns true.
The control used to enter the value.
The to which the value is to be assigned.
The error message, assigned if the check fails.
True.
Copies the value from the control to the tag.
The source control containing the value.
The to which the value is assigned.
Copies the value from the tag to the control.
The control to which the value is copied.
That source containing the value.
Represents customization parameters for input of numeric tag values.
Initializes a new instance of the class.
Initializes a new instance of the class.
The minimum allowed value.
The maximum allowed value.
Increment for the spin buttons.
Editor precision (decimal places).
Copies the properties of the specified object to the current object.
The source object to copy properties from.
Creates a .
The tag to edit.
The maximum width of the control.
The newly created control.
Checks the value contained in the control.
The control used to enter the value.
The to which the value is to be assigned.
The error message, assigned if the check fails.
True if the value falls between the minimum and maximum allowable values, false otherwise.
Copies the value from the control to the tag.
The source control containing the value.
The to which the value is assigned.
Copies the value from the tag to the control.
The control to which the value is copied.
That source containing the value.
Gets or sets the minimum allowed value.
Gets or sets the maximum allowed value.
Gets or sets the increment for the spin buttons.
Gets or sets the editor precision (decimal places).
For internal use.
Specifies a referenced object in an expression in a .
The parent of the current object.
The next object at the same level as the current object.
The previous object at the same level as the current object.
The current object.
An object with the specified name.
The current page.
The current page column.
An object with the specified Id
(provided for backward compatibility only).
A page with the specifid index.
For internal use.
Enumerates the single-dimensional coordinates and sizes of an object.
The default dimension.
The left edge of an object.
The top edge of an object.
The right edge of an object.
The bottom edge of an object.
The width of an object.
The height of an object.
Enumerates units of measurement used in a ,
used by and related types.
Units specified by a document's are used.
Specifies the document unit (1/300 inch) as the unit of measure.
Specifies the inch as the unit of measure.
Specifies the millimeter as the unit of measure.
Specifies the pica unit (1/6 inch) as the unit of measure.
Specifies a device pixel as the unit of measure.
Specifies a printer's point (1/72 inch) as the unit of measure.
Specifies a twip (1/1440 inch) as the unit of measure.
Specifies a hundredths of an inch as the unit of measure.
Specifies 1/75 inch as the unit of measure.
Specifies centimetre's as the unit of measure.
Measurement is relative to the height of the element's font.
Measurement is relative to the height of the lowercase letter x of the element's font.
Measurement is relative to the spacing between two lines of element's font.
For internal use.
The abstract base class representing a single coordinate or dimension of an object.
Initializes a new instance of the class.
Converts a string to a value. The string can be one of the following:
"def", "doc", "in", "mm", "pc", "pix", "pt", "tw", "inhs".
This method is case-insensitive.
The string to convert. If it is null or empty, is returned.
OUT: On exit, contains the value.
true if no error occurred, false otherwise.
Converts a value to a string representation as in
the following table:
- DefaultEmpty string
- Document"doc"
- Inch"in"
- Millimeter"mm"
- Pica"pc"
- Pixel"pix"
- Point"pt"
- Twip"tw"
- InHs"inhs"
A to convert.
The string representing .
Converts a string to a value.
The string can be one of the following:
"left", "top", "right", "bottom", "width", "height".
This method is not case sensitive.
The string to convert. If s is null or empty, is returned.
OUT: A corresponding to the specified string.
true if no error occurred, false otherwise.
Parses a string and creates a instance from that string.
The string to parse.
Indicates whether to throw an exception if the string cannot be parsed.
A instance. Depending on ,
this may be a , a , a or a .
If is false, null is returned if an error occurred.
Gets a value indicating whether the current object represents an auto length.
Gets a value indicating whether the current object represents a zero length.
Gets a value indicating whether the current object represents an absolute length.
Gets an instance of representing an auto length.
Converts to/from other types.
Converts a string to a .
An that provides a format context.
The string to convert.
A representing .
Converts an object to a string.
An that provides a format context.
The object to convert.
The converted string.
For internal use.
Represents an automatic dimension or coordinate.
Only one instance of this type can be created, it can be accessed via .
The string "auto" can be used in expressions as an alias for this type.
Compares the current length with another object.
This method performs comparison by value.
The object to compare the current with.
true if the two objects repesent the same length, false otherwise.
Gets the hash code for the current object,
based on the length value.
The hash code.
Converts the current object to a string.
"auto".
For internal use.
Represents an absolute length value, such as "5mm", "10in", "20" and so on.
Initializes a new instance of the class
from a string representing the length value.
The string used to initialize the value, such as "5mm" or "10in".
Initializes a new instance of the class
from a value and unit of measurement.
The length value.
Unit of measurement of .
Compares the current length with another object.
This method performs comparison by value.
The object to compare the current with.
true if the two objects repesent the same length, false otherwise.
Gets the hash code for the current object,
based on the length value.
The hash code.
Converts the current object to a string.
The returned string can be converted back to the current length object
(e.g. it can be used to initialize a to the same value).
The string representing the current length value.
Compares the current object with another object.
A object to compare the current one with.
The document providing the context for comparison.
The font providing the context for comparison.
0 if the two objects represent equal lengths,
-1 if the current length is less than the other,
1 if the current length is greater than the other,
-2 if the units of measurement cannot be compared.
Gets the numeric value (expressed in ).
Gets the unit of measurement used by .
Contains predefined values.
Gets a instance representing an empty length
(defined as "0mm").
Gets a instance representing the default line thickness
(equal to 1pt).
This is used for borders, grid lines etc.
Gets a instance representing the default bold line thickness
(equal to 2pt).
This is used for borders, grid lines etc.
Gets an array of predefined values
(, and ).
For internal use.
Represents a length value that references a coordinate or a dimension of another object.
(Examples of such references are "parent.width", "MyObjectName.right", "prev.height"
or "MyObjectName.MySubObjectName.Width".)
Initializes a new instance of the class
from a string representing the length reference.
The string used to initialize the value, such as "parent.width" or "MyObject.right".
Initializes a new instance of the class
from a nested object reference and a dimension.
A identifying the referenced object.
The target dimension of this LengthRef.
Initializes a new instance of the class
from a predefined source reference and a dimension.
A identifying the referenced object.
The target dimension of this LengthRef.
Compares the current length with another object.
This method performs comparison by value.
The object to compare the current with.
true if the two objects repesent the same length, false otherwise.
Gets the hash code for the current object,
based on the length value.
The hash code.
Converts the current object to a string.
The returned string can be converted back to the current length object
(e.g. it can be used to initialize a to the same value).
The string representing the current length value.
Gets the array of objects composing the path to the target object of the current reference length.
If the current reference
If the current object uses a simple (not nested) reference such as "parent.width",
this array contains just one element, corresponding to the parent object.
If the current object uses a nested reference such as "parent.MyChildName.width",
this array contains a element for each object in the hierarchy
(one for parent, and one for MyChildName in this example).
Gets the target dimension of the referenced object.
A structure representing a single referenced object in a
(if the LengthRef uses a hierarchical reference, each object in the hierarchy
of nested objects is represented by an instance of this structure).
Specifies the referenced object as a .
Specifies the name of the referenced object if is .
Specifies the page or column number if is
or .
Initializes a new instance of the structure
with the specified source.
A identifying the source of the current reference.
Initializes a new instance of the structure
with the specified source, source name and page/column number.
A identifying the source of the current reference.
The source name
(used if is ).
The source page/column number
(used if is
or ).
Initializes a new instance of the structure
with the specified source and page/column number.
A identifying the source of the current reference.
The source page/column number
(used if is
or ).
Initializes a new instance of the structure
with the specified source name.
The source name
( is set to by this constructor).
Converts the current object to a string.
The returned string can be converted back to the current length object
(e.g. it can be used to initialize a to the same value).
The string representing the current length value.
Contains and provides access to a number of commonly used
predefined objects.
Gets a instance representing the "Parent.Left" reference.
Gets a instance representing the "Parent.Top" reference.
Gets a instance representing the "Parent.Width" reference.
Gets a instance representing the "Parent.Height" reference.
Gets a instance representing the "Prev.Right" reference.
Gets a instance representing the "Prev.Bottom" reference.
Gets a instance representing the "Prev.Height" reference.
Gets a instance representing the "Next.Height" reference.
Gets a instance representing the "Parent.Default" reference.
Gets a instance representing the "Self.Default" reference.
Gets a instance representing the "Parent.Right" reference.
Gets a instance representing the "Parent.Bottom" reference.
Gets a instance representing the "Self.Width" reference.
Gets a instance representing the "Self.Height" reference.
Gets a instance representing the the "Page.Width" reference.
Gets a instance representing the "Page.Height" reference.
Gets a collection of containing all lengths
defined by the class.
For internal use.
Represents a length value which is an expression comprising instances of
, , and operations on them
(represented by static properties of type, such as LengthExp.Add) .
(Examples of such expressions are "parent.width + 5mm", "80%parent.width", and so on.)
Initializes a new instance of the class
with an array of operands and operations in inverse Polish notation order.
The operands and operations comprising the current ,
in inverse Polish notation order.
The array should be a valid inverse Polish notation
stack of operands and operations such as:
- : represents an absolute length value;
- : represents a coordinate or dimension of another object;
-
A built-in function:
- : maximum;
- : minimum.
-
An operation:
- : add;
- : subtract;
- : multiply;
- : divide;
- : percentage;
- : unary minus;
- : unary plus;
- : bracket (opening or closing);
- : empty argument.
Compares the current object with another stack of
operands and operations in inverse Polish notation
(see remarks in for details).
This method compares values of the two stacks.
A inverse Polish notation stack of operands and operations that are compared to the current expression.
Compares the current length expression with another object.
This method compares operation stacks of the two objects
using the method.
The object to compare the current with.
true if the two objects repesent the same length, false otherwise.
Gets the hash code for the current object,
based on the values in the length expression stack.
The hash code.
Converts the current object to a string.
The returned string can be converted back to the current length object
(e.g. it can be used to initialize a to the same value).
The string representing the current length value.
Gets the expression stack, as described in remarks
to .
Gets an array of all registered (supported) operators.
Gets an array of all registered (supported) unary operators.
Gets an array of all registered (supported) functions.
Gets the static instance of the class,
can be used in the constructor.
Gets the static instance of the class,
can be used in the constructor.
Gets the static instance of the class,
can be used in the constructor.
Gets the static instance of the class,
can be used in the constructor.
Gets the static instance of the class,
can be used in the constructor.
Gets the static instance of the class,
can be used in the constructor.
Gets the static instance of the class,
can be used in the constructor.
Gets the static instance of the class,
can be used in the constructor.
Gets the static instance of the class,
can be used in the constructor.
Gets the static instance of the class,
can be used in the constructor.
Gets the static instance of the class,
can be used in the constructor.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Holds some predefined LengthExp objects.
For internal use.
A structure representing a single coordinate or dimension of an object
(e.g. or of a )
in a .
The value may be "auto", absolute (e.g. "5mm"), or an expression (e.g. "prev.width + 12mm").
See for more details.
Initializes a new instance of the structure
from a string. See remarks for details.
A string representing the value.
(In the description that follows, "object" means a
or another document object on which the current Unit represents a dimension
or a coordinate, not the Unit structure itself.)
The string should contain a valid value
in one of the following forms:
-
Auto, represented by the string "auto".
The exact semantics depend on the type of object with which the current unit is associated.
-
An unqualified numeric value, e.g. "8" or "100.12".
In this case determines the unit of measurement.
-
A numeric value qualified with unit of measurement, e.g. "28mm" or "7in".
The following unit type qualifiers are supported
(for each type, the corresponding element of the enumeration is listed):
- def is used
(; this is equivalent to not specifying untis at all);
- doc"Document" units (; 1/300th of an inch);
- inInches ();
- mmMillimeters ();
- pcPicas (; 1/6 of an inch);
- pixDevice pixels (; depend on );
- ptPoints (; 1/72 of a inch);
- twTwips (; 1/1440 of a inch);
- inhs1/100 of an inch ();
- dsp"Display" units (; 1/75 of an inch);
- cmCentimeters ();
- em"Em size" (; object font's height);
- ex"Ex size" (; object font lowercase x's height);
- lsObject font's line spacing ().
-
A percentage of the object's parent size, optionally qualified with the parent's dimension
("width" or "height"; if a dimension is not specified, the dimension the current unit referes to is assumed),
e.g. "50%width" or "120%".
(Percentage can only be used to specify width or height, and is not valid for coordinates.)
-
A reference to a dimension or coordinate of another object,
e.g. "prev.width", "next.bottom" or "page1column2.width".
The referenced object may be identified by any of the following key words:
- selfThe current object. Default, may be omitted;
- parentThe current object's parent (container);
- prevThe previous sibling of the current object;
- nextThe next sibling of the current object;
- pageThe current page;
- columnThe current page column;
- pageNPage by number, N is 1-based
(e.g. "page8"; the page must already exist - forward references using this notation are not supported);
- pageindexNPage by index, N is 0-based
(e.g. "page0");
- columnMColumn by number, M is 1-based, on the current page (e.g. "column2");
- pageN.columnMColumn M on page N, M and N are 1-based (e.g. "page8.column2");
- object nameObject with the specified name (see ).
The object is first searched among the siblings of the current object, then among its children.
The referenced dimension or coordinate may be specified using any of the following key words:
- leftThe X coordinate of the left edge of an object;
- topThe Y coordinate of the top edge of an object;
- rightThe X coordinate of the right edge of an object;
- bottomThe Y coordinate of the bottom edge of an object;
- widthThe width of an object;
- heightThe height of an object.
-
A Max or Min built-in function call, e.g. "Max(prev.width,6cm)" or "Min(0.5in,next.height)".
-
An expression using operands in any of the forms described above (except "auto"),
combined using operators + (add), - (subtract), * (multiply), / (divide), % (percent),
functions Min and Max, and parentheses ( and ).
Examples of unit expressions are:
- prev.width + 50%prev.widthThis expression can be used to specify the width of an object being 1.5 times the width of its previous sibling
- 150%prevSame as above
- prev * 1.5Same as above but using multiplication instead of percentage
Initializes a new instance of the structure
with an absolute length value.
The unit value.
The unit of measurement.
Returns a string that represents the current object.
A string that represents the current object.
Compares the current unit value with another object.
The object to compare the current with.
true if the two objects repesent the same unit value, false otherwise.
Gets the hash code for the current unit value.
The hash code.
Attempts to convert the current unit value to other unit of measurement.
Only absolute units can be converted.
This method throws an exception if the conversion cannot be performed.
The target .
The value in units.
Attempts to convert the current unit value to other unit of measurement.
Only absolute units can be converted.
This method throws an exception if the conversion cannot be performed.
The target .
The target resolution (used if is ).
The value in units.
Attempts to convert the current unit value to other unit of measurement.
Only absolute units can be converted.
This method throws an exception if the conversion cannot be performed.
The current unit value's resolution (used if is ).
The target .
The target resolution (used if is ).
The value in units.
Attempts to convert an object to a unit value.
This method throws an exception if the conversion cannot be performed.
An object to convert.
A unit value representing .
Tests whether the two unit values are equal.
The first unit value.
The second unit value.
true if the two units are equal, false otherwise.
Tests whether the two unit values are not equal.
The first unit value.
The second unit value.
true if the two units are not equal, false otherwise.
Gets a value indicating whether the current unit represents an empty value.
Gets the absolute value of the current unit (in ).
Gets the unit of measurement of the current unit.
Gets a value indicating whether the current unit represents an "auto" value.
Gets a value indicating whether the current unit represents an absolute value
(such as "1mm", "2in", "3em" and so on).
Gets a value indicating whether the current unit is specified as "parent.width".
Gets a value indicating whether the current unit is specified as "parent.height".
Gets a value indicating whether the current unit is specified as "parent".
Gets a representing an "auto" value.
Gets a representing an emtpy (zero) value.
Gets a value representing the default line thickness (1 point wide).
Gets a value representing the default "bold" line thickness (2 points wide).
Provides type conversions for values.
Converts a string to a object.
An that provides a format context.
The string to convert.
The converted value.
Converts an object to a string.
An that provides a format context.
The object to convert.
The converted string.
Tests whether an object can be converted to the specified type.
The conversion context.
The target type.
true if the conversion can be performed, false otherwise.
Converts an object to the specified type.
The conversion context.
The culture to use.
The value to convert.
The target type.
The converted object.
Represents a point on a two-dimensional surface,
with coordinates specified as values.
Initializes a new instance of the structure.
The X coordinate.
The Y coordinate.
Converts the current value to a human-readable string.
The string representing the current value.
Converts a string to a structure.
The string to convert.
OUT: The structure representing .
Indicates whether an exception should be thrown if the conversion cannot be performed
(if an error occurs, and this value is false, is set to ).
true if no error occurred, false otherwise.
Gets or sets the X coordinate of the current point.
Gets or sets the Y coordinate of the current point.
Represents a with zero coordinates.
Provides type conversions for values.
Converts a string to a value.
An that provides a format context.
The string to convert.
The converted value.
Converts an object to a string.
An that provides a format context.
The object to convert.
The converted string.
Contains common functions.
Contains common functions.
Contains common functions.
Millimeters per inch as double.
Document units per inch as double.
Points per inch as double.
Twips per inch as double.
Picas per inch as double.
Centimeters per inch as double.
Display units per inch as double.
Millimeters per inch as float.
Document units per inch as float.
Points per inch as float.
Twips per inch as float.
Picas per inch as float.
Centimeters per inch as float.
Display units per inch as float.
For internal use only.
For internal use only.
For internal use only.
Tests whether the specified color is invisible
(i.e. equals or ).
The color to test.
true if the specified color is invisible, false otherwise.
Tests whether specified colors are equal.
First color.
Second color
true if the specified colors are equal, false otherwise.
Tests whether specified color is white.
The color to test.
true if the specified color is white, false otherwise.
Tests whether specified color is black.
The color to test.
true if the specified color is black, false otherwise.
Tests whether specified color is transparent.
The color to test.
true if the specified color is transparent, false otherwise.
For internal use only.
For internal use only.
Tests two sizes for equality allowing a small margin for rounding errors.
The first size to compare.
The second size to compare.
True if the two sizes are reasonably close, false otherwise.
Tests whether an object can be represented as a .
The object to test.
true if the object supports a ,
false otherwise.
Gets the representing the passed object,
If the passed document is a or , returns that object.
Otherwise, if the passed document is a ,
returns that report's property.
Otherwise, returns null.
A document to test/convert.
representing the passed object, or null.
Tests whether an object of the specified type can be represented
as a .
The type to test.
true if the specified type can be represented as a ,
false otherwise.
Tests whether an object can be represented as a .
The object to test.
true if the object is a or a ,
false otherwise.
Gets the representing the passed object,
If the passed document is a , returns that object.
Otherwise, if the passed document is a ,
returns that report's property.
Otherwise, returns null.
A document to test/convert.
representing the passed object, or null.
Tests whether an object of the specified type can be represented
as a .
The type to test.
true if the specified type can be represented as a ,
false otherwise.
Converts a value from one unit of measurement to another.
The value to convert.
The source unit of measurement.
The target unit of measurement.
The source DPI (used if is ).
The target DPI (used if is ).
converted to units.
For internal use.
Implements the static methods for comparing the float and double numbers
with specified precision.
For internal use.
For internal use.
Contains localizable design-time strings.
Gets the "Warning" string.
Gets the "Question" string.
Gets the "None" string.
Gets the "Error" string.
Contains localizable design-time strings for the root group.
Gets the "overwrite a readonly file?" format string.
Contains error strings.
Gets the "errors while saving resources" format string.
Contains strings designer strings.
Gets the "All" string.
Contains error strings.
Gets the "Localizer can be used under MS Visual Studio only." string.
Contains localizer strings.
Gets the "Localize..." string.
Gets the "Culture [{0}] already added to the current translation." format string.
Gets the "Exception occurs during loading strings from resource file:\r{0}\rException message:\r{1}" format string.
Gets the "The translation has been changed, save?" string.
Gets the "Select product to translate" string.
Gets the "Select project to store translation" string.
Gets the "Resource image with name [{0}] is not found." format string.
Gets the "Invariant culture" string.
Gets the "You have selected {0} culture to delete, there are {1} strings of this culture. Are you sure?" format string.
Gets the "You have selected {0} cultures to delete, there are {1} strings of these cultures. Are you sure?" format string.
Gets the "Can't create the [{0}] folder in the project.\rError message:\r{1}" format string.
Contains the open translation dialog strings.
Gets the "Solution '{0}'" format string.
Gets the "Can't build list of cultures" string.
Represents a localization .
Initializes a new instance of the class.
The designed component.
The component designer.
Returns the list of associated action items.
The list containing the "Localize" item.
Performs localizaion.
Performs localizaion.
The designer to localize.
Represents the editor of enum properties with FlagsAttribute attribute.
Gets the editor style used by the method.
The override for returns .
Edits the specified object's value using the editor style
indicated by the method.
Gets a value indicating whether drop-down editors should be resizable by the user.
The override for returns true;
Specifies the page orientation.
Use the members of this enumeration to set the value of the
property in the class.
Set the orientation automatically, based on the current
and report width ().
Use Portrait orientation (tall).
Use Landscape orientation (wide).
Specifies where the Page Footer and Page Header sections are displayed.
Use the members of this enumeration to set the value
of the and properties
in the class.
The page footer and header are printed on all pages of a report.
The page header isn't printed on the same page as the report header.
The page footer isn't printed on the same page as the report footer.
The page footer and header are not printed on a page that has either a report header or a report footer.
Specifies where the background picture is displayed.
Use the members of this enumeration to set the value of the property in the class.
Do not show the background picture.
Show the background picture on all pages.
Show the background picture on the first page only.
Show the background picture on all pages but the first.
Specifies the alignment of text within the field's rectangle.
Use the members of this enumeration to set the value
of the property in the class.
Align numbers to the right, other values to the left.
Align to the left and to the top of the field box.
Align to the center and to the top of the field box.
Align to the right and to the top of the field box.
Align to the left and to the bottom of the field box.
Align to the center and to the bottom of the field box.
Align to the right and to the bottom of the field box.
Align to the left and to the middle of the field box.
Align to the center and to the middle of the field box.
Align to the right and to the middle of the field box.
Justify and align to the top of the field box.
Justify and align to the bottom of the field box.
Justify and align to the middle of the field box.
Specifies the alignment of images within the field's rectangle.
Use the members of this enumeration to set the value of the
and properties
in the and classes.
Align to the left and to the top, clipping if necessary.
Align to the center and to the top, clipping if necessary.
Align to the right and to the top, clipping if necessary.
Align to the left and to the bottom, clipping if necessary.
Align to the center and to the bottom, clipping if necessary.
Align to the right and to the bottom, clipping if necessary.
Align to the left and to the middle, clipping if necessary.
Align to the center and to the middle, clipping if necessary.
Align to the right and to the middle, clipping if necessary.
Align to the left and to the top, clipping if necessary.
Scale the picture to use as much of the page as possible,
while preserving the picture's aspect ratio.
Stretch the picture to fill the page.
Tile the picture to fill the page.
Specifies the scaling of images within the field's rectangle.
Use the members of this enumeration to set the value of the
and properties in the and classes.
Use the image's original size, clipping it to the display area if necessary.
Stretch the picture to fill the display area.
This mode will usually change the image's aspect ratio.
Scale the picture to fit the display area.
This mode may increase or reduce the size of the image
while maintaining its aspect ratio.
Tile the picture to fill the display area.
Hide the picture.
Specifies how boolean values are translated into check boxes.
Use the members of this enumeration to set the value
of the property in the class.
This property is useful when you wish to display boolean values graphically,
rather than using text.
No checkbox (display as text).
Checkbox.
Crossbox.
Radio button.
Specifies the Field’s border style.
Use the members of this enumeration to set the value
of the property in the class.
No border.
Solid border.
Dashed border.
Dotted border.
Dash-dot border.
Dash-dot-dot border.
Determines whether/how a line should be drawn across the field
(as opposed to a box around the field).
Use the members of this enumeration to set the value
of the property in the class.
Regular field (not a line).
Render field as a vertical line (if Height > Width)
or as a horizontal line (if Width > Height).
Render field as a line between the left-top
and right-bottom corners of the field box.
Render field as a line between the left-bottom
and right-top corners of the field box.
Determines whether page breaks should be inserted before or after a field or section.
Use the members of this enumeration to set the value of the and
properties in the and classes.
No page breaks.
A page break is inserted before the field or section.
A page break is inserted after the field or section.
Page breaks are inserted before and after the field or section.
In multi-column reports, a page break is inserted before the field or section instead of column break.
In multi-column reports, a page break is inserted after the field or section instead of column break.
Specifies the direction of the text in the field.
Use the members of this enumeration to set the value
of the property in the class.
Text direction is normal.
Text direction is up.
Text direction is down.
Determines what type of barcode will be used in the field.
Use the members of this enumeration to set the value
of the property in the class.
No barcode.
Alpha-numeric, (Code 3 of 9).
Alpha-numeric.
Alpha-numeric, denser than Code39 and required at least 6 characters.
Numeric only.
Numeric only, slightly denser than Code39.
Numeric only, US Postal Service.
EAN-13 barcode. EAN-13 encodes 12-digit article codes
(plus one check digit created by the control).
EAN-8 barcode. EAN-8 encodes 7-digit article codes
(plus one check digit created by the control).
UPC-A barcode. UPC-A encodes 11-digit article codes
(plus one check digit created by the control).
UPC-E is a variation of UPC-A which allows for a more compact barcode by eliminating
"extra" zeros. Since the resulting UPC-E barcode is about half the size as an UPC-A
barcode, it is generally used on products with very small packaging.
When using the UpcE encoding, set the Text property to an 11-digit string as
if you were using the UpcA encoding.
Note that not all UpcA codes can be encoded in UpcE.
If the manufacturer code ends with "000", "100", or "200", the product number must be <= 900.
If the manufacturer code ends with "00" but not with "100", "200", or "300", then the product number must be <= 90.
If the manufacturer code ends with "0" but not with "00", then the product number must be <= 9.
If the manufacturer code does not end with "0", then the product number must be between 5 and 9.
The purpose of GS1-128 (formerly known as UCC-128 or EAN-128) is to
establish a standard way of labeling a package with more information
than just a product code.
It provides supplemental information such as batch number and "use before" dates.
There are two main components of UCC/EAN/GS1-128: the data with its Application
Identifier and the bar code symbology used to code the data.
The bar code symbology is code 128.
The difference is the use of defined Application Identifiers with data
encoded into the code 128 symbol.
Specifies compatibility options for a .
Properties in this class can be used to control compatibility
with older versions of C1Report.
Resets all properties to their default values.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets a value indicating whether to use the old method of type conversion
in report script functions CStr, CDbl and CDate.
The default is false. See remarks for details.
In versions of C1Report prior to 2012 v1, the following rules were used by
type conversion script functions CStr, CDbl, CDate:
- CStr used Application.CurrentCulture.
- CDbl used InvariantCulture, if that failed Application.CurrentCulture was used.
- CDate used InvariantCulture.
Starting with the 2012 v1 release, the rules changed to:
- CStr uses Application.CurrentCulture.
- CDbl and CDate use Application.CurrentCulture, if that fails then InvariantCulture is used.
Specifies the type of the data source.
Different data sources use different connection string and query command syntaxes.
The data source type is automatically determined base on connection string.
Using this value is not recommended as connecting to the data source may be very slow.
Specifies an OLE DB data source.
Specifies an ODBC data source.
Specifies an SQL server compact edition version 3.5 data source.
Specifies an SQL server compact edition version 4.0 data source.
Specifies that connection string is the name of an XML file containing a DataSet object.
Specifies that connection string is the name of an assembly that contains objects
which implement the interface.
For internal use only.
For internal use only.
Provides data for reports.
Most reports specify their data sources by setting the and
properties. The DataSource object uses these values to connect
to a database and retrieve the report data.
Alternatively, you can assign data objects directly to the property.
This approach is more efficient in scenarios where the data has already been loaded by the
application for other purposes, and can be used in the report directly instead of loading a copy.
Defines default IsolationLevel for transaction used to get report data.
Returns a string representation of object.
The value of property if supplied by the user,
or "(none)" otherwise.
Processes the PARAMETERS clause in the string and returns the result.
This property is related to the property.
The property sets or returns a string that specifies the source
dataset for the report, and it may contain a PARAMETERS clause that causes
to prompt the user for information.
If you wanted to use the value of the property to open a dataset
directly from your program, you would have to parse the PARAMETERS clause yourself.
If set to true, user will be prompted for the parameters
before the method returns. If set to false, the default values will be used.
The string (SQL statement or table name) that can be used to open a recordset.
Gets the value of the given field, at the cursor position.
Index of the field.
Value of the field.
Returns true if the cursor is pointing at the first record in the data source.
Returns true if the cursor is pointing at the last record in the data source.
Moves the cursor to the first record in the data source.
Moves the cursor to the last record in the data source.
Moves the cursor to the previous record in the data source.
Moves the cursor to the next record in the data source.
Returns the current cursor position.
Index of current record.
Sets the current cursor position to supplied value.
Index of record.
Gets or sets the type of the data source.
The data source type determines the syntaxes of connection string and query (record source).
The default is Auto but it is recommended that you change that value to one of specific
data source types, as automatic determination of the data source type may be very time consuming.
Gets or sets the string used to open a database.
The is used by the class to load the report data.
The class uses an object to retrieve the data,
so the syntax for the is the one used OleDb connection strings. For details on
the syntax, see the documentation for the class.
The specifies the database that contains the report data.
The property specifies which table, stored procedure, or Sql command to use for
retrieving the data.
If you want to use a different type of connection (e.g. a ,
or if your application already has the data available in a object, you can assign the data
directly to the property.
Gets or sets a string that specifies which table, stored procedure, or Sql command
to use for retrieving the report data.
The specifies the database that contains the report data.
The property specifies which table, stored procedure, or Sql command to use for
retrieving the data.
If you want to use a different type of connection (e.g. a ,
or if your application already has the data available in a object, you can assign the
data directly to the property.
Gets or sets the expression used to filter which data rows are included in the report.
Use the Filter property to restrict the records that you want to include in a
report without modifying the property.
Using a filter is similar to specifying a WHERE clause in the SQL statement assigned to
the property. Both techniques will filter the data according to the
condition specified. The difference is that the Filter property is applied to a table
that has already been loaded in memory, while the WHERE statement causes only the filtered
records to be loaded from the database into memory.
When creating reports that include only small subsets large tables, the WHERE statement
is a better option, because it doesn't require the entire table to be loaded into memory.
On the other hand, if the table has already been loaded in memory, the Filter property
is a better option, since it does not require any additional data to be loaded.
The syntax for the filter expression is the same used to specify the
property for objects. The expressions consist of conditions in the form
ColumnNameOperatorValue, where ColumnName is the name of a column in
the data source (optionally enclosed in square brackets), Operator is one of the regular
Visual Basic comparison operators, and Value is a literal enclosed in single quotes. Conditions
may be concatenated using AND and OR operators.
The code below shows how to apply a filter to a data source using the Filter property and
using a WHERE clause in a SQL statement:
if (useFilterProperty)
{
// load all records, filter in memory
_c1r.DataSource.RecordSource = "SELECT * from Employees";
_c1r.DataSource.Filter = "HireDate >= '1/1/1993' AND Country = 'UK'";
}
else
{
// load selected records only
_c1r.DataSource.RecordSource = "SELECT * from Employees " +
"WHERE HireDate >= #1/1/1993# AND Country = 'UK'";
Gets or sets the maximum number of data rows to be included in the report (set to zero to include all rows).
This property is useful if you want to limit the size of a report. For example, you may write a report
designer with a preview window that shows only the first 500 records from the database.
Setting this property to zero causes the control to retrieve all records.
You can also limit the size of reports by setting the property.
Sets or gets the data source object that provides data to the report.
Usually, the control creates a object based on the value of the
and properties, and uses that object
as the report data source.
Alternatively, you may want to create the data source object yourself, and assign it to
the control. You can do that by assigning your data source object to the Recordset
property.
When a DataTable or DataView object is assigned to the Recordset
property, C1Report automatically creates an internal wrapper class that implements
the interface. Because of this, you can't get the original
DataTable or DataView objects back by reading the property value. Instead,
you must cast the wrapper object to an and use the
method instead, as shown in the example below.
You can assign objects of the following types to the property:
(1) objects, (2) objects, or (3) any
object that implements the interface.
// create a DataTable
DataTable dt = new DataTable("my table");
// assign it to c1report
// automatically creates IC1ReportRecordset wrapper
c1r.DataSource.Recordset = dt;
// 1) this doesn't work (dbBad == null)
object wrapper = c1Report1.DataSource.Recordset;
DataTable dtBad = wrapper as DataTable;
// 2) this does (dtGood == dt)
DataView dv = ((IListSource)wrapper).GetList() as DataView;
DataTable dtGood = dv.Table;
Gets or sets the number of seconds to wait before the data connection times out
(set to -1 to use the default value, usually 30s).
Gets the report that contains this .
Gets or sets the isolation level for OleDBTransaction
used to retrieve the report data.
The default is IsolationLevel.ReadCommitted.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
used to edit VBScript expressions.
shows a modal dialog that allows users to enter VBScript
expressions.
You can use this in classes that derive from
to provide VBScript expression editing.
Gets the editor style used by the method.
An that can be used to gain additional context information.
Always returns UITypeEditorEditStyle.Modal.
Edits the value of the specified object.
An that can be used to gain additional context information.
An through which editing services may be obtained.
An instance of the value being edited.
A string containing the new value of the object.
used to edit VBScript statements.
shows a modal dialog that allows users to enter VBScript
statements.
You can use this in classes that derive from
to provide VBScript statement editing.
Gets the editor style used by the method.
An that can be used to gain additional context information.
Always returns UITypeEditorEditStyle.Modal.
Edits the value of the specified object.
An that can be used to gain additional context information.
An through which editing services may be obtained.
An instance of the value being edited.
A string containing the new value of the object.
used to edit properties.
This editor calls a delegate on the report object. Report designers can provide a delegate and show
their custom UI to use for editing the data source.
Gets the editor style used by the method.
An that can be used to gain additional context information.
A value that indicates the style of editor used by .
Edits the specified object's value using the editor style indicated by .
An that can be used to gain additional context information.
An that this editor can use to obtain services.
The object to edit.
The new value of the object.
Shows a page setup dialog where the use can pick the paper size, orientation, and margins.
Gets the editor style used by the method.
An that can be used to gain additional context information.
A value that indicates
the style of editor used by .
Edits the specified object's value using the editor style indicated by .
An that can be used to gain additional context information.
An that this editor can use to obtain services.
The object to edit.
The new value of the object.
used to edit measurements.
converts units (in, ", pt, pix, cm, mm) into
twips. For example, if the user types "2in" into the property grid, the
converter will automatically convert that into 2880 twips).
You can use this in classes that derive from
to provide properties that represent measurements.
Converts the given value to the type of this converter.
An that can be used to gain additional context information.
The to use as the current culture.
The to convert.
A value that represents the converted value expressed in twips.
used to edit formatting strings.
provides a list of commonly used formatting strings.
The user can select one or type his own.
You can use this in classes that derive from
to provide properties that represent formatting strings.
Returns true to indicate that this object supports a standard set of values that can be picked from a list.
An that can be used to gain additional context information.
Always returns true.
Returns false to indicate that the collection of standard values returned from
is not an exclusive list (the user can type custom formats that are not on the list).
An that can be used to gain additional context information.
Always returns false.
Returns a collection of standard formats.
An that can be used to gain additional context information.
A list containing the most common formatting strings.
used to edit text alignment properties
(properties of type ).
This editor shows a drop-down control that allows users to visually select text alignment options.
You can use this in classes that derive from to provide
text alignment editing.
Initializes a new instance of the class.
Gets the editor style used by the method.
An that can be used to gain additional context information.
Always returns UITypeEditorEditStyle.DropDown.
Edits the value of the specified object.
An that can be used to gain additional context information.
An through which editing services may be obtained.
An instance of the value being edited.
A value containing the new value of the object.
used to edit image alignment properties
(properties of type ).
shows a drop-down control that allows users to visually select
image alignment options.
You can use this in classes that derive from to
provide image alignment editing.
Initializes a new instance of the class.
Gets the editor style used by the method.
An that can be used to gain additional context information.
Always returns UITypeEditorEditStyle.DropDown.
Edits the value of the specified object.
An that can be used to gain additional context information.
An through which editing services may be obtained.
An instance of the value being edited.
A value containing the new value of the object.
that provides a list of available text field names plus the option to type in an
expression using a script editor.
used to edit properties that represent report field names.
shows a drop-down list that allows users to select report field names.
The list includes a (Script Editor...) option that shows a dialog where the user can type complex expressions.
You can use this in classes that derive from to provide properties
that should be set to report field names.
Initializes a new instance of the class.
Gets the editor style used by the method.
An that can be used to gain additional context information.
Always returns UITypeEditorEditStyle.DropDown.
Edits the value of the specified object.
An that can be used to gain additional context information.
An through which editing services may be obtained.
An instance of the value being edited.
A string containing the new value of the object.
used to edit properties that represent reports.
provides a list of available reports.
You can use this in classes that derive from to
edit properties that represent reports.
Returns whether this converter can convert an object of one type to the type of this converter.
An that can be used to gain additional context information.
A that represents the type you want to convert from.
True if is string, false otherwise.
Converts the given value to the type of this converter.
An that can be used to gain additional context information.
The to use as the current culture.
The to convert.
A object with the specified name, or null if no report by the specified name
could be found in the report definition file.
Returns whether this converter can convert the object to the specified type.
An that can be used to gain additional context information.
A that represents the type you want to convert to.
True if is string, false otherwise.
Converts the given value object to the specified type.
An that can be used to gain additional context information.
The to use as the current culture.
The to convert.
A that represents the type you want to convert to.
The name of the report if is string, null otherwise.
Returns whether this object supports properties, using the specified context.
An that provides a format context.
True because should be called to find the properties of this object.
Returns whether the collection of standard values returned from
is an exclusive list of possible values,
using the specified context.
An that provides a format context.
True because the returned
from is an exhaustive list of possible values.
Returns a collection of report names.
An that provides a format context that can be
used to extract additional information about the environment from which this converter is invoked.
This parameter or properties of this parameter can be a null reference (Nothing in Visual Basic).
A that holds a standard set of valid values.
PictureHolderEditor provides a list of available text image names plus the option to load an image from a file.
Initializes a new instance of the class.
Gets the editor style used by the method.
An that can be used to gain additional context information.
A value that indicates the style of editor used by .
Edits the value of the specified object.
An that can be used to gain additional context information.
An through which editing services may be obtained.
An instance of the value being edited.
A string containing the new value of the object.
Base class for all export filters, used with the method to render
reports into different formats.
ExportFilter is an abstract class used as a base class for all the built-in export filter classes,
, , , ,
, and .
You can write your own export filters by deriving from ExportFilter.
Initializes a new instance of the class.
Releases the resources used by the filter.
Override this method in derived classes to free any disposable objects used by the filter.
Called when the component starts rendering a report.
Owner report.
Called when the component starts rendering a section.
The to render.
Left position of the section, in twips.
Top position of the section, in twips.
Called when the component needs to render a report field with specific content at a specific
position on the current page.
object to render.
Rectangle that determines the field position on the page, in twips.
Field text to render.
Field image to render.
Called when the component finishes rendering each .
that was rendered.
Called when the component finishes rendering a report.
Called after each page break on paged reports (see the property).
Called after the component has finished rendering the first pass of the report,
and before it starts rendering overlay fields.
Overlay fields are used only in reports that contain calculated fields which use the Pages
property.
This value is not known until the report has been generated, and is therefore rendered on a second pass.
Called when the component renders the beginning of a report group.
Outline header.
Outline level.
Left position of the outline, in twips.
Top position of the outline, in twips.
This method allows the filter to build a report outline.
Determines whether this filter generates single or multi-page reports.
When generating paged reports, the component calls the filter's
method on page breaks and updates the value of the property.
When generating non-paged (continuous) reports, only one long page is generated.
True if report is paged.
Returns a value that determines whether the filter requires page images to be generated.
By default, will render the report into the filter
and also into its own collection.
Some filters use these images to generate their output (e.g. PDF, TIFF). Other filters
don't need the images (e.g. HTML, RTF) and therefore this method returns false, which saves some
resources while rendering long reports.
True if the filter requires page images.
Used with the method to render reports into HTML streams or files.
Creating an HtmlFilter and using it in a call to the
method is similar to using the or
methods, but offers some extra flexibility because you can set properties on the HtmlFilter object
before calling RenderToFilter.
Initializes a new instance of the class attached to a file.
Contains the name of the file to be created.
If the file already exists, it will be overwritten.
Initializes a new instance of the class attached to a stream.
Output stream where the report will be rendered.
Initializes a new instance of the class attached to a stream.
Output stream where the report will be rendered.
A unique report identifier used to avoid duplicate style names
when adding several reports to the same HTML stream.
Path and template of file name for member files (pictures etc).
Called when the component starts rendering a report.
Owner report.
Determines whether this filter generates single or multi-page reports.
When generating paged reports, the component calls the filter's
method on page breaks and updates the value of the property.
When generating non-paged (continuous) reports, only one long page is generated.
True if report is paged.
Returns a value that determines whether the filter uses page images.
By default, C1Report will render the report into the filter and also into its own
collection.
doesn't need the images and therefore this method always
returns false, which saves some resources while rendering long reports.
Always returns false.
Called after each page break on paged reports (see the property).
Called when the component starts rendering a section.
The section being rendered.
Left position of the section, in twips.
Top position of the section, in twips.
Called when the component finishes rendering each section.
Section that was rendered.
Called when the component needs to render a report field with specific content at a
specific position on the current page.
The field to be rendered.
Rectangle that determines the field position on the current page, in twips.
Field text to render.
Field image to render.
Called after the component has finished rendering the first pass of the report,
and before it starts rendering overlay fields.
Overlay fields are used only in reports that contain calculated fields which use
the Pages variable.
This value is not known until the report has been generated, and is therefore
rendered on a second pass.
Called when the component finishes rendering a report.
Called when the component finishes rendering a report, or when the rendering
process is canceled by the user or interrupted by an error.
Use this method to free any disposable objects used by the filter.
Create and save style sheet for the report.
Save style sheet into the given .
that will contain the style sheet.
Whether the style sheet should be initially configured in the collapsed state.
Encodes the start of a new page.
Encodes the end of the current page.
Breaks up an HTML output file containing multiple pages into multiple files.
Name of the file to break up into pages.
True if the file was broken up successfully.
Gets a CSS style fragment that represents a field's background image.
that contains the image.
to be rendered in the field.
A CSS style fragment that represents a field's background image.
Gets an HTML tag that represents an image in a field.
that contains the image.
to be rendered in the field.
Whether to use absolute positioning in the HTML IMG tag.
An HTML IMG tag to show the image, or an empty string if the field has no image.
Gets an HTML tag that represents a link in a field.
that contains the link.
An HTML tag that represents a link in a field.
Gets a plain text version of an RTF string.
that owns the text.
Text to encode.
An plain text version of the RTF string.
Specifies whether the filter should produce a continuous
report into a single HTML file or a paged report into a set of HTML files.
Specifies whether the built-in HTML filter should break paged reports
into multiple HTML files (one per page).
Set this property to false to create a single HTML file containing all pages,
with <BR> elements at the page breaks.
Specifies whether the user should be able to expand and collapse groups by clicking on their header sections.
Specifies whether reports should be initially displayed in a collapsed state.
Specifies whether field contents should be encoded or rendered in raw format.
This property allows you to render fields that contain HTML formatting.
By default, field contents are encoded, so a field containing the string "A<B>C"
would be rendered as "A<B>C", which would appear as the original string
in the browser.
If you set to False, the same string would be rendered in
raw format, causing the browser to display it as "A<B>C" (the "C" would be bold).
Class is used with the method to render reports into
table-based HTML streams or files.
This filter is similar to the plain , except if generates reports
based on TABLE tags as opposed to absolutely-positioned DIV tags. The resulting files are
usually less accurate than the ones created with the plain DIV-based ,
but they have three significant advantages:
1) TABLE-based reports are easier to edit in regular HTML editors. You can easily insert rows for example.
2) TABLE-based reports support clipboard operations better. For example, you can copy report sections
in the browser and paste them into Excel.
3) TABLE-based reports support vertical alignment within fields.
Initializes a new instance of the class attached to a file.
Contains the name of the file to be created.
If the file already exists, it will be overwritten.
Initializes a new instance of the class attached to a stream.
Output stream where the report will be rendered.
Initializes a new instance of the class attached to a stream.
Output stream where the report will be rendered.
A unique report identifier used to avoid duplicate style names
when adding several reports to the same HTML stream.
Path and template of file name for member files (pictures etc).
Called when the component starts rendering a report.
Owner report.
Called when the component finishes rendering a report.
Called when the component starts rendering a section.
The section being rendered.
Left position of the section, in twips.
Top position of the section, in twips.
Called when the component finishes rendering each section.
Section that was rendered.
Called when the component needs to render a report field with specific content at a
specific position on the current page.
The field to be rendered.
Rectangle that determines the field position on the current page, in twips.
Field text to render.
Field image to render.
Create and save style sheet for the report.
Save style sheet into the given .
that will contain the style sheet.
Whether the style sheet should be initially configured in the collapsed state.
Encodes the end of a new page.
Encodes the end of the current page.
Gets or sets the number of pixels between adjacent cells in the output table.
Gets or sets the number of pixels between the edge of the cell and its contents.
Used with the method to render reports into compressed metafile files.
This filter creates zip files containing one metafile for each report page.
Creates a new instance of the class.
Name of the zip file that will contain the report metafiles.
Called when the component starts rendering a report.
Owner report.
Called when the component finishes rendering a report.
Gets or sets the type of metafile this will generate.
Used with the method to render reports into PDF (portable document format)
streams or files.
Creating a PdfFilter and using it in a call to is similar to
using the or methods,
but offers some extra flexibility because you can set properties on the PdfFilter before calling
RenderToFilter.
Initializes a new instance of the class attached to a file.
Full name of the file to be created. If the file already exists, it will be overwritten.
Initializes a new instance of the class attached to a stream.
Output where the report will be rendered.
Called when the component starts rendering a report.
Owner report.
Called when the component finishes rendering a report.
Specifies whether the filter should embed font information into the PDF output.
Embedding font information makes the PDF document substantially larger, but it allows the file to be
viewed faithfully in systems that don't have all the necessary fonts installed.
Embedding fonts is not necessary if the target systems have the necessary TrueType
fonts installed.
Gets or sets the owner password associated with the PDF document.
The owner password is required for making changes to the document.
This property is deprecated. The new property
allows you to set owner and user passwords, as well as permissions for editing and
printing the document.
Specifies whether the PDF output should include an outline tree.
The outline tree is created automatically based on the report groups and
can be used to navigate through the report in the Adobe Acrobat viewer.
Each node in the tree corresponds to a group header section in the report.
Invisible group header sections do not generate outline entries in the PDF document.
Gets a object that specifies who can use the Pdf document and what actions are allowed.
Gets a object that specifies how the viewer should display the Pdf document.
Contains options that determine who can use the Pdf document and what actions are allowed.
Gets or sets whether the user can copy contents from the Pdf document.
Gets or sets whether the user can edit annotations in the Pdf document.
Gets or sets whether the user can edit the contents of the Pdf document.
Gets or sets whether the user can print the Pdf document.
Gets or sets the password required to change permissions for the Pdf document.
Gets or sets the password required to open the Pdf document.
Specifies the page layout to be used when the Pdf document is opened.
Do not specify a layout and use the current viewer default.
Display one page at a time.
Display the pages in one column.
Display the pages in two columns, with odd-numbered pages on the left.
Display the pages in two columns, with odd-numbered pages on the right.
Specifies how the Pdf document should be displayed when opened.
Document outline visible if available.
Neither document outline nor thumbnail images visible.
Document outline visible.
Thumbnail images visible.
Full-screen mode, with no menu bar, window controls, or any other window visible.
Contains options that determine how the viewer should display the Pdf document.
Gets or sets whether to position the document's window in the center of the screen.
Gets or sets whether to resize the document's window to fit the size of the first displayed page.
Gets or sets whether to hide the viewer menu bar when the document is active.
Gets or sets whether to hide the viewer tool bars when the document is active.
Gets or sets the page layout to be used when the Pdf document is opened.
Gets or sets how the document should be displayed when opened.
Specifies the format of the export file.
Use the members of this enumeration to set
property of the class.
This setting creates RTF content that can be viewed in Microsoft Word,
WordPad and RichTextBox.
This setting creates RTF content that can be viewed in Microsoft Word.
It is useful for exporting high quality images. Documents with such images
are significantly larger than with images in Portable format.
Used with the method to render reports into RTF (rich text format)
streams or files.
Creating an RtfFilter and using it in a call to the method
is similar to using the or
methods, but offers some extra flexibility because you can set properties on the RtfFilter
before calling RenderToFilter.
Initializes a new instance of the class attached to a file.
Full name of the file to be created. If the file already exists, it will be overwritten.
Initializes a new instance of the class attached to a stream.
Output where the report will be rendered.
Called when the component starts rendering a report.
Owner report.
Determines whether this filter generates single or multi-page reports.
Always returns true.
Returns a value that determines whether the filter uses page images.
Always returns false.
Called when the component needs to render a report field with specific content at a specific
position on the current page.
object to render.
Rectangle that determines the field position on the page, in twips.
Field text to render.
Field image to render.
Called after each page break on paged reports (see the property).
Called after the component has finished rendering the first pass of the report,
and before it starts rendering overlay fields.
Called when the component finishes rendering a report.
Called when the component finishes rendering a report, or when the rendering
process is canceled by the user or interrupted by an error.
Use this method to free any disposable objects used by the filter.
Gets an RTF representation of a field's .
that contains the font.
Indicates that should be ignored.
A string containing the RTF representation of the font.
Specifies whether filter should embed images in the RTF document.
Documents with embedded images are significantly larger than text-only documents.
Gets or sets the format used to export images.
Class is used with the method to render reports into RTF
(rich text format) streams or files.
This filter is similar to the plain , except if generates RTF fields with
absolute positioning. The resulting files are more accurate than the ones created with the plain RTF
filter, but they are harder to edit and can only be opened in Microsoft Word (WordPad and other simple
editors do not support RTF absolute positioning).
Creating an RtfLabelFilter and using it in a call to the method
is similar to using the or
methods, but offers some extra flexibility because you can set properties on the RtfLabelFilter
before calling RenderToFilter.
Initializes a new instance of the class attached to a stream.
Output where the report will be rendered.
Initializes a new instance of the class attached to a file.
Full name of the file to be created. If the file already exists, it will be overwritten.
Called when the component needs to render a report field with specific content at a
specific position on the current page.
The field to be rendered.
Rectangle that determines the field position on the current page,
in twips.
Field text to render.
Field image to render.
Used with the method to render reports into plain text streams or files.
Creating a TextFilter and using it in a call to the
method is similar to using the or
methods, but offers some extra flexibility because you can set properties on the TextFilter before
calling RenderToFilter.
Initializes a new instance of the class attached to a file.
Full name of the file to be created. If the file already exists, it will be overwritten.
Initializes a new instance of the class attached to a stream.
Output where the report will be rendered.
Called when the component starts rendering a report.
Owner report.
Determines whether this filter generates single or multi-page reports.
When generating paged reports, the component calls the filter's
method on page breaks and updates the value of the property.
When generating non-paged (continuous) reports, only one long page is generated.
True if report is paged.
Returns a value that determines whether the filter uses page images.
Always returns false.
Called when the component needs to render a report field with specific content at a specific
position on the current page.
object to render.
Rectangle that determines the field position on the page, in twips.
Field text to render.
Field image to render.
Called after each page break on paged reports (see the property).
Called after the component has finished rendering the first pass of the report,
and before it starts rendering overlay fields.
Called when the component finishes rendering a report.
Called when the component finishes rendering a report, or when the rendering
process is canceled by the user or interrupted by an error.
Use this method to free any disposable objects used by the filter.
Specifies whether the filter should produce a continuous report or a report with
page break characters and page header and footer sections.
Used with the method to render reports into TIFF streams or files.
Creating a TiffFilter and using it in a call to the
method is similar to using the or
methods, but offers some extra flexibility because you can set properties on the TiffFilter before
calling RenderToFilter.
Initializes a new instance of the class attached to a file.
Full name of the file to be created. If the file already exists, it will be overwritten.
Initializes a new instance of the class attached to a stream.
Output where the report will be rendered.
Called when the component starts rendering a report.
Owner report.
Called when the component finishes rendering a report.
Gets or sets the resolution of the TIFF document, in dots per inch.
The default value for this property is 300 DPI.
Setting the resolution to higher values result in documents with higher quality
but significantly larger size, especially if the property
is set to false.
Gets or sets whether the TIFF document should be saved in monochrome format.
The default value for this property is true, which results in much smaller documents that are compatible
with fax machines (the compression used is CompressionCCITT4).
Set this property to false to generate color documents which use LZW compression but are substantially
larger than monochrome documents (often 100 times larger using the same resolution).
Class used with the method to render reports into Microsoft Excel (XLS) files.
Creating an XlsFilter and using it in a call to the method is similar
to using the method, but offers some extra flexibility because you can set
properties on the XlsFilter before calling RenderToFilter.
Initializes a new instance of the class attached to a file.
Full name of the file to be created.
If the file already exists, the filter will open it and will add a new sheet with the report.
Initializes a new instance of the class attached to a .
where the sheet will be saved.
Called when the component starts rendering a report.
Owner report.
Determines whether this filter generates single or multi-page reports.
Always returns false.
Returns a value that determines whether the filter uses page images.
Always returns false.
Called when the component needs to render a report field with specific content at a specific
position on the current page.
object to render.
Rectangle that determines the field position on the page, in twips.
Field text to render.
Field image to render.
Called when the component finishes rendering a report.
Called when the component finishes rendering a report, or when the rendering
process is canceled by the user or interrupted by an error.
Use this method to free any disposable objects used by the filter.
Gets or sets the name of the worksheet to be used when saving the report into the Excel workbook file.
You can use this property to save multiple reports into a single Excel workbook file, one on each sheet.
Gets or sets a value that determines whether cells should be shaded in the Excel workbook file.
Set this property to false to create smaller files without any cell shading.
Gets or sets a value that determines whether images should be exported to the Excel workbook file.
Set this property to false to create smaller files without any images.
Gets or sets a value that determines whether header sections should be frozen on the sheet.
Set this property to true to freeze rows that contain the ReportHeader and PageHeader sections.
Frozen rows remain visible when the user scrolls the sheet.
Gets or sets a value indicating whether the Excel workbook file should only include
the report's data and ignore formatting.
Gets or sets whether to export the file using the OpenXml format used by Microsoft Excel 2007 and later.
Determines whether to calculate a running sum.
Use the members of this enumeration to set the value
of the property in the class.
Do not treat field as a running sum.
Calculate running sum over each group.
Calculate running sum over the whole report.
Determines how the field is positioned with respect to its containing section
when the section grows or shrinks as a result of the section's
and properties.
Use the members of this enumeration to set the value
of the property in the class.
The field does not move. The space between the top of the field
and the top of the section remains the same.
The field moves vertically. The space between the bottom of the field
and the bottom of the section remains the same.
The field grows or shrinks. The space between field and the section
remains the same (above and below).
Determines whether the field will be rendered with an opaque or transparent background.
Transparent background.
Opaque background.
Displays individual data items in a report.
Every element visible in a report is represented by a Field object.
Fields can display text, images, expressions, lines, rectangles, or subreports.
Initializes a new instance of the class.
Selects the text or image that will be rendered by the field.
Field text.
Chart image.
This parameter allows the field to render differently at design time or run time.
This is usually needed for bound controls, since no data is available at design time.
Override this method in derived classes to provide custom text or images to be rendered in the report.
Override in derived classes to provide advanced persistence mechanism.
Override in derived classes to provide advanced persistence mechanism.
Returns a description of the field (name, location, size).
Brings a field to the front or sends it to the back of the ZOrder.
Determines whether the field is brought to the front or sent to the back
of the ZOrder.
Creates a new object that is a copy of the current object.
Copy of the current object.
Returns whether a subreport has data and suppresses rendering if it doesn't.
This property allows you to check whether a subreport has data and prevent it from rendering if it doesn't.
The code below uses script to hide sections with empty subreports:
_c1r.Sections.Detail.OnPrint = "Detail.Visible = fSubreport.SubreportHasData"
The code below uses script to hide a field containing an empty subreport and show another field instead:
_c1r.Sections.Detail.OnPrint =
"hasData = fSubreport.SubreportHasData\r\n" +
"fSubreport.Visible = hasData" +
"fNoData.Visible = Not hasData\r\n" +
Gets or sets the type of geometric shape drawn by the current field.
The default is None.
Gets or sets an instance of the -derived class specifying
properties of the geometric shape drawn by this field (if is not None).
Gets or sets the field name.
The field name can be used as an index into the control's collection.
Field names are also used to identify fields in VBScript expressions, as shown in the example
below.
Duplicate and empty field names are allowed, but should be avoided if you plan to use the field names
in scripts or as indexers.
The code below assigns a script to the report's section. The script
changes a field's property depending on a value.
_c1r.Sections.Fields["sampleField"].ForeColor = Color.Black;
_c1r.Sections.Detail.OnFormat =
"sampleField.ForeColor = iif(someValue < 5, vbRed, vbBlack)";
Specifies whether the will be rendered in the report.
Gets or sets extra data needed by the calling program.
Returns the position of the field in the parent report's collection.
Gets or sets the section to which the field belongs.
To move a field from one section to another, set its property to a new value.
Gets the that contains this field.
Gets the that contains this field.
Gets or sets the field's text.
The property contains the text that will be rendered on the report.
This value may be rendered literally (without any translation) or it may be evaluated as a
VBScript expression, depending on the setting of the property.
The code below creates two fields. One displays the label "Sales Tax", the other displays the
tax value by multiplying a database field ("Sales") by a constant.
// display literal Text
_c1r.Field[0].Text = "Sales Tax";
_c1r.Field[0].Calculated = false;
// display a calculated value
_c1r.Field[1].Text = "Sales * 0.085";
_c1r.Field[1].Calculated = true;
Specifies whether the property should be interpreted as a literal value
or as a calculated expression.
If this property is set to false, the value of the property is rendered
on the report without any further processing.
If it is set to true, the value of the property is evaluated as a
VBScript expression and the result of the expression is rendered on the report.
The code below creates two fields. One displays the label "Sales Tax", the other displays the
tax value by multiplying a database field ("Sales") by a constant.
// display literal Text
_c1r.Field[0].Text = "Sales Tax";
_c1r.Field[0].Calculated = false;
// display a calculated value
_c1r.Field[1].Text = "Sales * 0.085";
_c1r.Field[1].Calculated = true;
Gets or sets the field's calculated value.
When a field's property is set to true, the control evaluates
the expression stored in the property and stores the result in the
property, which gets rendered into the report.
This is the field's default property, so when you use a field name in a VBScript
expression, you are actually referring to the field's property.
Specifies whether duplicate values in consecutive records should be suppressed.
You can use the property to hide a field on a report
when its value is the same as in the preceding record.
For example, on a report listing suppliers and their products, each supplier's name
can appear once for each group of products, rather than once for each product.
Specifies whether to show a running sum for the field.
You can use the property to calculate record-by-record or
group-by-group totals in a report.
The property specifies whether a calculated field on a report
displays a running total and lets you set the range over which values are accumulated.
Gets or sets the x-coordinate of the field's left edge in twips.
A field's location is the distance from its upper left corner to the upper left corner
of its containing .
Setting the or property to zero places the field at
the very left or top of its containing section.
Gets or sets the y-coordinate of the field's top edge in twips.
A field's location is the distance from its upper left corner to the upper left corner of its containing
.
If the field's or properties are set to true, the control will
automatically adjust the property to fit the field's contents and the
property of fields below the current field to preserve the vertical distance between fields. The value of the
and properties is not affected.
Gets or sets the width of the field in twips.
Every object has a rectangle, or "field box", where the field contents are rendered.
The field box is defined by the , , , and properties.
These properties are expressed in twips, and the position is relative to the field's containing section.
Gets or sets the height of the field in twips.
Every object has a rectangle, or "field box", where the field contents are rendered.
The field box is defined by the , , , and properties.
These properties are expressed in twips, and the position is relative to the field's containing section.
The field's property should be set to a value larger than or equal to the height of the
field's , or no text will appear in the field.
If the field's or properties are set to true, the control will
automatically adjust the property to fit the field's contents and the
property of fields below the current field to preserve the vertical distance between fields. The value of the
and properties is not affected.
Specifies whether to insert page breaks before or after the field.
Specifies whether the field height should be automatically increased to fit the field's contents.
You can use the and properties to control
the appearance of report fields and sections. When you set both properties to true, the field
or section automatically adjusts so any amount of data can be printed. When a field grows or
shrinks, the fields below it move down or up the page.
If you set a field's property to true, the control automatically
sets the property of the containing section to true. (However, if you
set a control's property to true, the control doesn't set the section's
property to true.)
When you use the and properties, remember that:
1. The property settings don't affect the horizontal spacing between fields; they affect
only the vertical space the fields occupy.
2. The height of a large field can prevent fields beside it from shrinking. For example,
if several short controls are on the left side of a report's detail section and one tall control,
such as an unbound object frame, is on the right side, the controls on the left won't shrink,
even if they contain no data.
Specifies whether the field height should be automatically reduced to fit the field's contents.
Specifies whether the field should be kept together on a page.
If this property is set to true, the control will insert page breaks in order to keep
the field contents together on a page.
If it is set to false, and the containing also has its
property set to false, then the field may be rendered across
two or more pages.
Gets or sets the field's vertical position relative to its containing .
Normally, fields do not move when sections grow or shrink. In some cases, however, you may want
fields to grow with the section or to stay in the same position relative to the bottom of the
section.
This is especially common for fields used to create vertical lines that should extend
the entire height of the section.
Gets or sets the ZOrder for the field.
The ZOrder of a field determines whether it is rendered in front of or behind
other fields that overlap with it.
High ZOrder values bring the field to the front, low values send it to the back.
Because ZOrder values are relative, it is usually easier to call the
method, which ensures the field is rendered in front of or behind all other overlapping fields.
Gets the y-coordinate of the field's top edge in twips after the and
properties have been applied to the containing .
If the field's or properties are set to true, the control will
automatically adjust the property to fit the field's contents and the
property of fields below the current field to preserve the vertical distance between fields. The value of the
and properties is not affected.
Gets the height of the field in twips after the and
properties have been applied to the field.
If the field's or properties are set to true, the control will
automatically adjust the property to fit the field's contents and the
property of fields below the current field to preserve the vertical distance between fields. The value of the
and properties is not affected.
Gets or sets the field's size and location within the section, in twips.
Gets or sets the field's size, in twips.
Gets or sets the field's location within the section, in twips.
Gets or sets the field's font.
If you set a field's font property to a value that
is too large to fit the field box (defined by the property),
no text will appear in the field.
Gets or sets the field's background color.
Gets or sets the field's foreground color.
Use the ForeColor property to specify the color for text in a field. You can use this property to make
fields easy to read or to convey a special meaning.
The code below uses script to change the color of the text in the UnitsInStock field when its value
falls below the reorder level.
// build script
string script = "UnitsInStock.ForeColor = " +
"IIF(UnitsInStock < ReorderLevel, vbRed, vbBlack)";
// assign script to detail section
_c1r.Sections.Detail.OnPrint = script;
Gets or sets a string used to format the field value.
You can use the property to customize the way numbers, dates, times,
and text are displayed and printed.
For example, if you've created a Price field, you can set its
property to "Currency". If the field value is set to "4321.678", it would be rendered as $4,321.68.
You can use the property to format numbers (including currency and percentage
values), dates, boolean values, and strings.
The syntax for the format string is the same used with the .NET method.
Gets or sets how text is aligned within the field.
This property determines how text is aligned within the field.
To control picture alignment, use the property.
Specifies whether the field's contents should be allowed to wrap within the field rectangle.
Gets or sets the direction of text within the field.
Gets or sets the angle of text rotation within the field (including barcodes).
Note that some output/export formats (such as HTML, RTF and plain text) do not support rotated text.
Gets or sets the line spacing between text lines in the field, in percent.
The default is 100 which corresponds to normal line spacing.
Note that this property is ignored if is true.
Gets or sets the spacing between the left edge of the field and its content, in twips.
This property is useful for rendering fields with borders or solid backgrounds, to add some space
between the borders and the field content.
Gets or sets the spacing between the top edge of the field and its content, in twips.
This property is useful for rendering fields with borders or solid backgrounds, to add some space
between the borders and the field content.
Gets or sets the spacing between the right edge of the field and its content, in twips.
This property is useful for rendering fields with borders or solid backgrounds, to add some space
between the borders and the field content.
Gets or sets the spacing between the bottom edge of the field and its content, in twips.
This property is useful for rendering fields with borders or solid backgrounds, to add some space
between the borders and the field content.
Gets or sets the field's border style.
To draw a border around a field, set the following properties:
to define the border color.
to define the border style (e.g., solid, dashed, etc.).
to define the border width (in twips).
When you create fields with text and a border, text will be positioned very close to the border. You can control
the distance between the text and the border using the , ,
, and properties.
To draw lines, see the property.
Gets or sets the width of the field's border or line.
To draw a border around a field, set the following properties:
to define the border color.
to define the border style (e.g., solid, dashed, etc.).
to define the border width (in twips).
To draw lines, see the property.
Gets or sets the field's border color.
To draw a border around a field, set the following properties:
to define the border color.
to define the border style (e.g., solid, dashed, etc.).
to define the border width (in twips).
Specifies whether a line should be drawn across the field (as opposed to a box around the field).
The color, style, and thickness of the line are determined by the , ,
and properties.
Gets or sets a picture to display on the field.
You may set this property to three types of object:
1) Regular .NET objects.
2) Strings containing image file names or Urls.
3) Strings containing names of image fields in the report data source.
Options 1 and 2 are used to create unbound images, such as logos. These images do not
depend on the report data.
Option 3 is used to create bound images, such as product or employee pictures. These
are images stored with the report data.
Gets or sets how field pictures should be the aligned.
Gets or sets how images should be the scaled to fit within the field area.
Depending on the setting of this property, images may be clipped, stretched, scaled (which preserves the
image's aspect ratio), tiled, or hidden.
PictureScale works with the property so you can control image scaling and
alignment independently.
Specifies whether the field should be displayed as a checkbox.
This property allows you to display boolean values graphically, rather than as plain text.
Specifies whether the field should render string enclosed in curly brackets as RTF.
If you set this property to true, any fields containing text
enclosed in curly brackets will be rendered as RTF.
This allows you to add complex formatting within a field.
Allows fields to be rendered in barcode format.
Gets or sets an expression that evaluates to a URL to be visited when the field is clicked.
If not empty, this should be an expression that evaluates to a URL. After the report is generated,
clicking on the field will cause the report viewer to navigate to the URL. The report viewer can be a web browser
(for HTML reports), Adobe Acrobat (for PDF reports), or other viewer applications.
Not all report viewers support hyperlinks. The PrintPreview control that ships with .NET, for example,
does not.
The field will be displayed as usual, based on the contents of its and
properties.
The expression is always evaluated, regardless of the setting of the
property (which only applies to the display text). This allows you to bind the to a field in the
data source, as show in the example below.
The code below creates two hyperlink fields, one with a static value and one based on a database value.
// set up a static link
Field f = c1r.Fields["companyInfoLink"];
f.Calculated = false;
f.Text = "click here for more info on our company";
f.LinkTarget = "http://myrealty.com";
// set up a databound link
Field f = c1r.Fields["propertyInfoLink"];
f.Calculated = false;
f.Text = "click here for more info on this property";
f.LinkTarget = "\"http://myrealty.com/moreinfo?id=\" & propertyID";
Gets or sets a reference to another report to be rendered within the field (a subreport).
A subreport is a report that is inserted in another report. Subreports are useful when you want to combine
several reports into one. For example, you may have a main report that integrates several subreports into a single
main report. Or you can use the main report to show detailed information and use subreports to show summary data
at the beginning of each group.
For some real-world examples, check the "Sales By Category" and "Sales By Year" reports in the NWIND.XML
sample that ships with the control.
To define a field as a subreport, you should start by loading the subreport, then assign the subreport
control to the field's property.
Next, link the subreport to the main report using the subreport field's property (this is
analogous to setting the LinkChildFields/LinkMasterFields properties in a Microsoft Access subreport). The
Text property in a subreport field is used as a filter. It specifies which records in the source recordset
should be used to render the subreport based on the current record for the main report.
When the main report is being rendered and reaches the subreport field, the Text expression is evaluated
and the result is uses as a filter condition for the subreport.
Building the link expression is not difficult, but it is a little tricky because it requires you to create a
string that contains quotes, and these internal quotes must be doubled (written as "").
If you are creating reports using the Report Designer, you don't have to worry about building the link expressions
in code. Instead, right-click the subreport field and select the Link Subreport... menu. This will show a dialog
where you can select the master and detail fields. When you click OK, the Report Designer will build the link expression
and assign it to the Text property of the subreport field automatically.
Subreport fields usually have the property set to true, so the subreport field can expand to
include all its records.
Subreports may contain other subreports. There's no set limit for the depth of report nesting you can have.
However, there must be no circular references to reports. In other words, a report cannot contain a reference to itself
as a subreport.
// load subreport and assign it to a field in the main report
string sSub = "Sales By Category Subreport";
c1Sub.Load("NWIND.XML", sSub);
c1rMain.Fields[sSub].Subreport = c1Sub;
// set up connection between main report and subreport
c1rMain.Fields[sSub].Calculated = true;
c1rMain.Fields[sSub].Text = "\"CategoryName = '\" & [CategoryName] & \"'\"";
Returns the value of the LinkTarget expression.
FieldCollection class represents a collection of the objects.
Adds a field to a collection.
Contains the name of the new field. You should use a consistent naming scheme for the fields
and avoid using duplicate names for report fields and database fields. Using repeated names is legal but will
cause VBScript expressions that use repeated field names to yield unexpected results.
Contains the value for the new field's property. This value
may be treated as a literal or as a VBScript expression, depending on the setting of the field's
property. By default, is set to false and the text
is rendered as-is.
Left coordinate of the new field, in twips, with respect to its containing section.
Top coordinate of the new field, in twips, with respect to its containing section.
Width of the new field, in twips.
Height of the new field, in twips.
A reference to the newly added field.
If you add a field to a section's collection, the new field is automatically
assigned to that section.
If you add a field to the control's collection, the new field is not assigned
to any sections. In this case, you must set the field's property or it will not be
rendered in the report.
Adds a field to a collection.
Contains the name of the new field. You should use a consistent naming scheme for the fields
and avoid using duplicate names for report fields and database fields. Using repeated names is legal but will
cause VBScript expressions that use repeated field names to yield unexpected results.
Contains the value for the new field's property. This value
may be treated as a literal or as a VBScript expression, depending on the setting of the field's
property. By default, is set to false and the text
is rendered as-is.
Defines the position of the field, in twips, with respect to its containing section.
A reference to the newly added field.
If you add a field to a section's collection, the new field is automatically
assigned to that section.
If you add a field to the control's collection, the new field is not assigned
to any sections. In this case, you must set the field's property or it will not be
rendered in the report.
Adds a field or a clone of a field to a collection.
A object to add to the collection.
A reference to the newly added field.
In the field does not belong to any reports, it is added to the collection. If the field already
belongs to a report, a clone is created and added to the collection.
Removes a field from a collection.
Specifies the field to be removed.
Removes a field from a collection.
Specifies the field to be removed.
Removes a field from a collection.
The name of the field to be removed.
Removes a field from a collection.
The field to be removed.
Determines whether the collection contains a specific field.
The name of the field.
True if the collection contains a field with the specified name;
otherwise, false.
Determines whether the collection contains a specific field.
Reference to the object.
True if the collection contains specified field;
otherwise, false.
Copies the elements of the collection to an , starting at a particular array index.
The one-dimensional that is the destination of the elements copied from collection.
The array must have zero-based indexing.
The zero-based index in array at which copying begins.
Returns a field from a collection.
The index parameter may be an integer between zero and -1.
Returns a field from a collection.
The name parameter may be a string containing a field name.
Returns the number of fields in a collection.
Specifies how groups should be sorted.
Use the members of this enumeration to set the value of
the property in the class.
Do not sort records for this group.
Sort records in ascending order.
Sort records in descending order.
Specifies whether the group should be kept together on a page.
Use the members of this enumeration to set the value of the and
property in the and classes.
Do not try to keep the group together.
Keep the group header, detail, and footer together on a page.
Keep the group header and first detail section together on a page.
Object used to sort and group report data.
Each Group has a Header section and a Footer section that can be used to display
aggregate information for the group.
Moves a group to a new position in the collection, optionally
adjusting its and .
Contains the new position for the group (index into the collection).
Determines whether only the group should be moved or whether its header and footer sections,
along with all the fields in those sections, should also be moved.
This method is useful in designer applications, when you want to allow users to change the grouping order.
Gets or sets the group name.
The group name can be used as an index into the control's collection.
Gets or sets the expression used to break records into groups.
This property contains a VBScript expression that is evaluated for every record
in the source recordset. A new group is started whenever the value of this expression changes.
Gets or sets how the group is sorted.
The specified sorting is applied to the content of the property. For example,
if contains the expression "FirstName" and is set to "Ascending",
then the group will be sorted in ascending order based on the content of the "FirstName" column in the data source.
Note that the sorting is performed by the data source itself, not by C1Report. Because of this, sorting
is always based on column names rather than calculated expressions. If the property contains a
calculated expression, the component will extract the first column name from the expression and will sort based on that
value. For example, if is set to "Left(FirstName, 3)", the sorting will be based on the
"FirstName" column, not on the first three characters of the first names.
This can present problems in a few cases, especially if you want to sort based on date parts (year, month, quarter).
In these cases, the recommended procedure is to add a calculated column to the data source (by changing the SQL statement
used to retrieve the data), then set the property to the name of the calculated column.
The code below uses a SQL statement to add a "HireQuarter" column to the data source, then sorts a group based on
this new column. The report will show employees sorted by the quarter when they were hired.
string sql =
"SELECT *, DATEPART('q', HireDate) AS HireQuarter " +
"FROM Employees";
c1r.DataSource.RecordSource = sql;
c1r.Groups[0].GroupBy = "HireQuarter";
c1r.Groups[0].Sort = SortEnum.Ascending;
Specifies whether the group should be kept together on a page.
Returns the used as this group's header.
Returns the used as this group's footer.
Gets or sets extra data needed by the calling program.
Gets the object that contains this .
GroupCollection class represents a collection of the objects.
Adds a new to the collection, along with header and footer sections for the new group.
Contains the name of the new group.
Contains the value of the property for the new group.
Contains the value of the property for the new group.
A reference to the newly added group.
When a group is added to a report, the control automatically adds two new sections, the group header and group
footer sections for the new group. These new sections are invisible by default.
Removes a from the collection,
and its header/footer sections from the collection.
Specifies the group to be removed.
Removes a from the collection,
and its header/footer sections from the collection.
The name of the group to be removed.
Removes a from the collection,
and its header/footer sections from the collection.
The group to be removed.
Determines whether the collection contains a specific group.
The name of the group.
True if the collection contains a group with the specified name;
otherwise, false.
Determines whether the collection contains a specific group.
Reference to the object.
True if the collection contains specified field;
otherwise, false.
Copies the elements of the collection to an , starting at a particular array index.
The one-dimensional that is the destination of the elements copied
from the collection. The array must have zero-based indexing.
The zero-based index in array at which copying begins.
Returns a group from a collection.
The index parameter may be an integer between zero and -1.
Returns a group from a collection.
The name parameter may be a string containing a group name.
Returns the number of groups in a collection.
Specifies the layout for the columns (down or across).
Use the members of this enumeration to set the value of the property
in the class.
Columns are laid out down the page, then across.
Columns are laid out across the page, then down.
Causes the report designer to discount label spacing in the design surface,
hide header/footer sections, disable grouping button,
and disable automatic section resizing when fields are moved or dragged.
The Layout object controls how the report is rendered on pages.
Returns a description of layout to show it in designer.
Copies information from the PrintDocument.PageSettings to the C1Report's .
True if object was changed.
This is useful if you want to make changes to the
object instead of the object.
Gets or sets the width of the report's detail section, in twips.
This property determines the width of the detail section of the report.
Multi-column reports have header and footer sections that span all columns so their actual width is
* .
For example, a two-column report with a one-inch wide detail section would have Width = 1440,
and its total width would be 2 * 1440 = 2880.
Gets or sets the left margin for each page, in twips.
The margins are measured in twips, from the edges of the paper. You can select the paper size and orientation using the
and properties.
Gets or sets the right margin for each page, in twips.
The margins are measured in twips, from the edges of the paper. You can select the paper size and orientation using the
and properties.
Gets or sets the top margin for each page, in twips.
The margins are measured in twips, from the edges of the paper. You can select the paper size and orientation using the
and properties.
Gets or sets the bottom margin for each page, in twips.
The margins are measured in twips, from the edges of the paper. You can select the paper size and orientation using the
and properties.
Gets or sets the number of detail columns.
Use this property to create multi-column reports.
In multi-column reports, header and footer sections span the full width of the report.
Only the detail section is rendered in multiple columns. Use the property to specify the width
of each column, and the property to specify whether columns should be laid out across
the page or down the page.
Multi-column reports are useful for printing reports on mailing labels and other types of multi-column
pre-printed forms. They are also useful for creating compact reports where detail information is laid out across
the page.
Gets or sets the layout for the columns (down or across).
Gets or sets the paper size for the report.
Gets or sets the custom width for the report, in twips.
To create reports using custom paper sizes, set the property to
, then set the and properties
to the size of the page measured in twips.
If the is set to a value other than , the paper size
is determined by that setting. The and properties are not
used in this case.
If the is set to and the or
properties are set to zero, the printer's default paper size is used.
Gets or sets the custom height for the report, in twips.
To create reports using custom paper sizes, set the property to
, then set the and properties
to the size of the page measured in twips.
If the is set to a value other than , the paper size
is determined by that setting. The and properties are not
used in this case.
If the is set to and the or
properties are set to zero, the printer's default paper size is used.
Gets or sets the page orientation.
Gets or sets a value that determines on which pages the Page Header section should be displayed.
You can use the PageHeader and PageFooter properties to specify whether a report's page header or
page footer should be printed on the same page as a report header or report footer.
For example, you might not want to print a page header containing the page number on the first page of a report
if the report header is a cover sheet.
Gets or sets a value that determines on which pages the Page Footer section should be displayed.
Gets or sets a background picture for the report body.
Use the property to specify a bitmap or other type of graphic to be displayed as a
background picture on a report (watermark-style).
Use the , , and properties
to specify which pages should display the picture and how it should be aligned and scaled.
Gets or sets how the background picture is aligned.
To select the background picture and which pages should display it, use the and
properties.
Gets or sets how the background picture is aligned.
This property determines how background images are scaled to fit the page. Depending on the setting of
this property, images may be clipped, stretched, scaled (which preserves the image's aspect ratio), tiled,
or hidden.
This property works with the property so you can control image scaling and
alignment independently.
Gets or sets where the background picture is displayed.
To select the background picture and how it should be aligned on the page, use the ,
, and properties.
Used by the designer to discount horizontal label spacing in the design surface.
Used by the designer to discount vertical label spacing in the design surface.
Gets a dictionary () with replacements
to be made in the report body.
This property is useful when implementing export filters.
Reports that contain page counts or group page counts save special tags in
the report body. When the report finishes rendering, these tags need to be replaced
with the actual page counts. Filters can get the list of tags and the replacement
values using this dictionary. The key-value pairs in the dictionary contain the
tags and their replacements.
The code below shows part of a text filter implementation. The EndReport
method gets the overlay replacement dictionary and calls a ReplaceInStream
method that scans each line in the stream and replaces any keys with the
corresponding values. For example, the total page count would be represented
by a key similar to "#pages#", which would be replaced everywhere in the stream
with the actual page count.
public class MyTextFilter : ExportFilter
{
// ...
override public void EndReport()
{
// close output stream
Layout layout = _ownerReport.GetLayout();
ReplaceInStream(_exportStream, layout.OverlayReplacements);
_exportStream.Close();
}
}
Gets the that contains this object.
Contains a collection of objects.
This collection is made available as a parameter in the
event, and allows handlers to
inspect and modify report parameter values while handling the event.
Gets a report parameter by name.
Gets a report parameter by index.
Gets the number of objects in the collection.
Represents a parameter in a parameterized report data source.
Gets the parameter name.
Gets the parameter type.
Gets or sets the parameter value.
Represents an external record set residing in a separate assembly.
If an assembly contains a type supporting this interface,
that assembly and type can be selected in the report designer
as the data source for a report. A reference to that type
and the record set initialization parameters (see )
are then saved in the XML report definition file.
When the report is loaded, the recordset object is created
based on the saved info, and used as the data source for the report.
This method is used to set up parameters of the current recordset.
For instance, the implementation of this method can show a dialog
allowing the user to edit the parameters.
Returns the interface used to access data.
The interface used to access data.
Gets the user-friendly name of the current recordset.
Gets or sets parameters of the current recordset.
Interface used to access report data from data source objects.
Any object that can be used as custom data source for reports must implement this interface.
The component provides this implementation for common data sources such
as and classes.
Gets a string vector with the names of each field in the data source.
A string vector with the names of each field in the data source.
Gets a vector with the types of each field in the data source.
A vector with the types of each field in the data source.
Gets the value of the given field at the current cursor position.
Index of the field.
Value of the field.
If the cursor is past the end of the data (EOF condition), this method should return null and
not throw exceptions.
Returns true if the cursor is pointing at the first record in the data source.
Returns true if the cursor is pointing past the last record in the data source.
Moves the cursor to the first record in the data source.
Moves the cursor to the last record in the data source.
Moves the cursor to the previous record in the data source.
Moves the cursor to the next record in the data source.
Returns the current cursor position.
Index of current record.
Sets the current cursor position to supplied value.
Index of record.
Applies a filter string. See the property for details.
Filter string.
Applies a sort string. See the property for details.
Sort string.
that is thrown when a data access error occurs.
Initializes a new instance of the DataAccessException class.
Initializes a new instance of the DataAccessException class with a specified error message.
A message that describes the error.
Initializes a new instance of the DataAccessException class with a specified error message
and a reference to the inner exception that is the cause of this exception.
The error message that explains the reason for the exception.
The exception that is the cause of the current exception.
Initializes a new instance of the DataAccessException class with serialized data.
The object that holds the serialized object data.
The contextual information about the source or destination.
Specifies the format of the export file.
Use the members of this enumeration to set parameter
of the method in the class.
Plain HTML format. This setting creates a single HTML file that can be viewed in any web browser.
Paged HTML format. This setting creates one HTML file for each page in the report, with links to navigate between pages.
Drill-down HTML format. This setting creates a single HTML file with collapsible headings. When viewed in a
DHTML-capable browser, clicking group headers causes them to collapse and expand to show the detail.
Adobe PDF format. This setting creates a PDF file that can be viewed using Adobe Acrobat software.
The PDF file includes an outline tree that is generated automatically based on the report structure.
Each node in the tree corresponds to a group header section in the report.
Invisible group header sections do not generate outline entries in the PDF document.
Adobe PDF format with embedded fonts. This setting creates a PDF file that can be viewed using Adobe Acrobat software.
Plain text. This setting creates a plain ASCII file.
RTF format. This setting creates an RTF file that can be opened in Microsoft Word, WordPad, or any other
RTF-capable text editor.
Microsoft Excel files. This setting creates a BIFF-8 Excel file that can be opened with Microsoft Excel 97 or later.
TIFF format. This setting creates multi-page TIFF files.
Deprecated. Use PDF, PDFEmbedFonts, or PDFProcted instead.
Protected PDF format. This setting creates a PDF file with a random password. The file can be opened and printed
by anyone, but cannot be modified.
RTF field-based format. This setting creates RTF files with absolutely-positioned fields. This format renders reports
more accurately than the plain RTF format, and is recommended for creating label-style reports.
However, the files created with this setting are harder to edit than the plan RTF format, and can only be
previewed or printed correctly using Microsoft Word (this format doesn't work with WordPad).
Plain text. This setting creates a plain ASCII file as a single page.
Compressed metafile. This setting creates a zip file containing one metafile (emf) per page. The default
file extensions for this format are "zip" or "emz".
OpenXml file. This setting creates an OpenXml Excel file that can be opened with Microsoft Excel 2007 or later.
Table-based HTML format. This setting creates a single HTML file that can be viewed in any web browser.
Unlike plain format, uses tables rather than absolute positioning to arrange objects.
Specifies the logic for handling CanGrow/CanShrink fields.
Use the members of this enumeration to set the value of the property in the class.
Uses the standard C1Report mode, where fields that grow or shrink affect only fields directly below.
Uses a mode that is similar to MS Access, where fields that grow or shrink affect all fields below,
even if they are off to the side of the field that grew or shrank.
Generates Access-style, data-based banded reports that can be rendered to printer, preview,
or exported to various portable formats (including XPS, HTML, PDF, and text).
Initializes a new instance of the component.
Releases the resources used by the component.
If true, managed resources as well as unmanaged resources are released;
if false, only unmanaged resources are disposed.
Raises the event.
that contains event data.
Raises the event.
that contains event data.
Raises the event.
that contains event data.
Raises the event.
that contains event data.
Raises the event.
that contains event data.
Raises the event.
that contains event data.
Raises the event.
that contains event data.
Raises the event.
that contains event data.
Raises the event.
that contains event data.
Raises the event.
that contains event data.
Raises the event.
that contains event data.
Signals the object that initialization is starting.
Signals the object that initialization is complete.
Gets a list of reports available in an XML report definition file.
Contains the stream with XML report definition.
A string array containing the names of all reports in the XML definition.
Gets a list of reports available in an XML report definition file.
Contains the full name of the XML report definition file.
A string array containing the names of all reports in the XML file.
Gets a list of reports available in an .
Reference to object.
A string array containing the names of all reports in the XmlDocument.
Clears the pages and other info created during report generation.
This method does not clear the report definition though.
Gets a list of reports available in an XML report definition file.
Contains the full name of the XML report definition file.
A string array containing the names of all reports in the XML file.
Gets a list of reports available in an .
Reference to the that contains the reports.
A string array containing the names of all reports in the XmlDocument.
Loads a report from an XML report definition in stream.
Stream containing XML report definition.
Name of the report to retrieve from the file (case-insensitive).
You can get a list of reports available in the file using the method.
Loads a report from an XML report definition file.
Full name of the XML report definition file.
Name of the report to retrieve from the file (case-insensitive).
You can get a list of reports available in the file using the method.
Loads a report from an .
Reference to the that contains the reports.
Name of the report to retrieve from the file (case-insensitive).
You can get a list of reports available in the file using the method.
Saves the current report definition to a file.
Full name of the file to be created (if the file already exists, it will be overwritten).
This method does not embed pictures and subreports into the output file. It only saves subreport names and saves
images in external files.
Saves the current report definition to a file.
Full name of the file to be created (if the file already exists, it will be overwritten).
Whether to embed images and subreports into the output file.
Saves the current report definition to a file.
Full name of the file to be created (if the file already exists, it will be overwritten).
Whether to embed images into the output file.
Whether to embed subreports into the output file.
Saves the current report definition to a stream.
The stream to save to.
Indicates whether to embed images into the output file.
Indicates whether to embed subreports into the output file.
Saves the current report definition to an object.
An object where the report definition will be saved.
This method does not embed pictures and subreports into the output file. It only saves subreport names and saves
images in external files.
Saves the current report definition to an XmlTextWriter object.
An object where the report definition will be saved.
Whether to embed images and subreports into the output stream.
Saves the current report definition to an XmlTextWriter object.
An object where
the report definition will be saved.
Whether to embed images into the output stream.
Whether to embed subreports into the output stream.
Clears the current report.
This method removes all groups, group sections, and fields from the current report.
It also resets the and objects, and clears
(but does not remove) the fixed sections that all reports have: Detail, Header,
Footer, PageHeader, and PageFooter.
Use this method when you want to clear a report and start creating a new one from scratch.
Evaluates a VBScript expression in the current report context.
A string with a VBScript expression to be evaluated.
The value of the expression.
Use this method to evaluate expressions as they would be evaluated while generating a report.
This can be useful in designer-type applications, to provide an "Immediate Window" where users can test
expressions.
If the expression string contains invalid syntax or causes an evaluation error, the control
raises the event. In this case, the Handled parameter of the event
is set to true, so the exception is ignored by default.
Expressions may contain simple VBScript expressions such as:
Console.WriteLine(_c1r.Evaluate("2+2"));
4
Console.WriteLine(_c1r.Evaluate(" \"A\" & \"B\" ");
AB
Expressions may also contain references to the Report object and all its sub-objects. For example:
Console.WriteLine(_c1r.Evaluate("Report.DataSource.RecordSource"));
SELECT * FROM Employees
Console.WriteLine(_c1r.Evaluate("Report.DataSource.Recordset.Fields.Count"));
7
Console.WriteLine(_c1r.Evaluate("Report.Fields(0).Name"));
FirstNameField
Finally, data fields, , and objects may be referenced directly by name.
Console.WriteLine(_c1r.Evaluate("FirstNameField.Value"));
Andrew
Console.WriteLine(_c1r.Evaluate("CategoryName"));
Beverages
Executes a VBScript statement in the current report context.
A string with VBScript instructions to be executed.
This method is similar to the method, except it does not return a value.
If the expression string contains invalid syntax or causes an evaluation error, the control
raises the event. In this case, the Handled parameter of the event
is set to true, so the exception is ignored by default.
Parses a VBScript expression in the current report context.
A string with a VBScript expression to be parsed.
An if the expression is invalid, or null if no errors
were detected.
This method is useful for providing VBScript syntax-checking in designer applications.
Parses a VBScript statement in the current report context.
A string with a VBScript statement to be parsed.
An if the statement is invalid, or null if no errors
were detected.
This method is useful for providing VBScript syntax-checking in designer applications.
Enumerates page images (represented by metafiles) of the generated report.
Using this method in a "foreach" loop allows to iterate over all pages of a large report
without exhausting system resources.
This approach is preferable to property that creates images
for all pages and can consume a large amount of resources.
An IEnumerable that allows to iterate over the page images.
You must call the method to create or refresh the pages.
Gets a metafile representing the specified page.
Use this method rather than the collection
as accessing that property creates images for all pages at once
and thus can exhaust system resources.
0-based page index.
The metafile representing the page.
You must call the method to create or refresh the pages.
Gets the total number of pages in the generated report.
Use this method rather than Count on the collection
as accessing that property creates images for all pages at once
and thus can exhaust system resources.
The total page count.
You must call the method to create or refresh the pages.
Renders the report into an internal collection of images.
This method is called implicitly when other classes access the
property, so you rarely have to call directly from your code.
In some cases, you may want to access the report as a collection of pages,
exposed by the property. To ensure that the image collection
is available and up-to-date, call the method directly.
Renders the report into a object.
Stream that will contain the report.
Report format to insert into the output stream.
This method is especially useful in ASP.NET scenarios where you want to render reports into
Html or Pdf streams, without creating temporary files.
Not all types of report can be rendered into streams. The Excel format requires OLE compound
files and can only be rendered into files.
Renders the report into an Html .
Stream that will contain the report.
Report format to insert into the output stream.
Unique ID used to differentiate multiple reports stored in the same stream.
Base file name used to build temporary image files.
This method is used by the C1WebReport control to generate Html reports in ASP.NET pages.
Renders the report into a file.
Name of the file that will contain the report.
Type of file to create.
This method causes the control to render the current report into a file. It is especially useful in server applications
that create several reports in batch mode, and don't have a user interface.
Renders the report into an object.
Export filter that will render the report.
includes several built-in export filters that allow you to export reports
to HTML, PDF, RTF, Excel, and other formats.
You may create your own filters by creating classes that derive from any of these base filters.
Copies a report definition from another component.
that contains the report to be copied.
This method is similar to copying the property from one
to another, but is substantially faster.
Note that while this method clones the fields of the report, in only makes shallow copies
of the fields' properties (so e.g. subreports are not cloned).
Adds an object to the report's script context.
Name of the new object (case-insensitive).
Value of the new object.
This method allows you to add custom objects to the context of the
script interpreter.
The script interpreter context is cleared whenever a report starts rendering, so this method
should always be called from the event handler.
The code below uses the event to add a variable called
"mainForm" to the script context. It then attaches some script to the report's
event to show the caption of the form when the report starts rendering.
private void _c1r_StartReport(object sender, System.EventArgs e)
{
_c1r.AddScriptObject("mainForm", this);
}
private void button1_Click(object sender, System.EventArgs e)
{
_c1r.OnOpen = "msgbox(mainForm.Text)";
_c1r.Render();
}
Adds an object to the report's script context.
Name of the new object (case-insensitive).
Value of the new object.
Whether to add the object to the script context of all subreports as well.
This method allows you to add custom objects to the context of the
script interpreter.
The script interpreter context is cleared whenever a report starts rendering, so this method
should always be called from the event handler.
Occurs periodically during document generation.
Allows to provide progress indication and the ability to cancel generation to the user.
Fired when the control starts rendering the report, before it opens the source recordset.
You can use this event to provide user feedback or to make changes to the
and
properties.
For example, you may implement your own version of parameterized queries by asking the
user to provide some information and changing the
property accordingly.
You may also use this event to assign a object directly to the
report's property. Applications that already have the
report data should do this to save time by preventing from loading its own copy
of the data.
Fired when the control finishes rendering the report.
Fired when the control starts rendering a report and the data source is empty.
You can use this event to cancel rendering a report when the source recordset is empty.
If you don't cancel the report, it will be rendered as an unbound report (a self-contained report
with no underlying data).
The code below cancels a report when it has no data:
private void c1r_NoData(object sender, EventArgs e)
{
_c1r.Cancel = true;
}
Fired when the control starts rendering each page.
This event is useful for updating the user interface to show how many pages have been printed so far.
You can use the property while handling this event to cancel rendering the report.
To limit the number of pages that can be printed, use the property instead.
Fired when the control finishes rendering each page.
This event is useful for updating the user interface to show how many pages have been printed so far.
You can use the property while handling this event to cancel rendering the report.
To limit the number of pages that can be printed, use the property instead.
Fired before each is formatted.
When this event fires, the report fields have not been updated with the current values or sizes.
This is a good point to set field formatting parameters and visibility based on the current data values.
This event is equivalent to the script property.
Fired before each is printed (after it has been formatted.)
When this event fires, the field values and sizes have been set by the control.
You may still make changes, but they will not affect the field layout. For example, changing a field's
property at this point will not cause it to grow or shrink.
This event is equivalent to the script property.
Fired when the control finishes rendering each .
Fired when an error occurs while rendering a report.
The most common types of errors found when rendering reports are:
1) Invalid or parameters.
This usually indicates that the system could not open the specified database (a server may be off line, or
a database file may be in a different location than what was specified) or that the SQL syntax used for the
property contains errors.
2) Error executing scripts or evaluating expressions. This usually indicates that the VBScript expression
used contains a syntax error. In these cases, make sure you look at the exception message. It usually contains a
good explanation of what caused the error.
Fired before the control displays the Report Parameters dialog.
Reports that have a PARAMETERS clause in their property
show a dialog where the user can enter report parameters.
This event fires before the dialog is displayed and allows you to customize the dialog by changing
its caption, font, colors, etc.
You can also use this event to inspect and modify parameter values using the
collection.
Finally, you can use the property to prevent the component
from showing the parameters dialog.
The code below uses the InitializeParametersDialog event to modify the values
of the report parameters and suppress the display of the parameter dialog.
private void c1Report1_InitializeParametersDialog(object sender,
C1.C1Preview.C1Report.DialogEventArgs e)
{
// change parameter values
ReportParameterCollection p = e.Parameters;
p["TheString"].Value = "east";
p["TheNumber"].Value = 12;
p["TheDate"].Value = DateTime.Now;
p["TheBool"].Value = true;
// don't show dialog
e.ShowDialog = false;
}
Fired before the control adds an outline entry to the report.
Some report output formats include an outline that is built Based on the report groups. For example, PDF
reports show this outline on the left pane of the reader application.
The outline contains one entry for each group header, and the entry text is based on the value of
the expression for the group.
This event allows you to change or suppress the text that appears on the outline.
Gets the object which determines compatibility
with previous versions of .
Gets or sets a value indicating whether hyperlinks in the report are colorized automatically.
The default is false (which is compatible with older versions of C1Report).
If the current report is generating (see ),
gets the approximate completion ratio, from 0 (0% complete) to 1 (100% complete).
If the report is currently not generating, gets 1.
Gets or sets the type of metafiles created by the current report.
The default is .
Gets or sets a value indicating whether all text in the current report
should be rendered using GDI+ text API.
The default value is false.
Gets or sets the name of the report (used with the Load method).
This property identifies the report when it is saved in a report definition file.
To retrieve a report from a report definition file, use the method
and pass this name as a parameter.
Gets or sets a object containing report metadata.
Reports may include general information such as a title, author, and keywords.
Such global information about the document itself (as opposed to its content or
structure) is called metadata, and is intended to assist in cataloguing and
searching for reports and report definitions in external databases.
Gets a reference to the report's object.
Gets a reference to the report's object.
Gets or sets the default font for new fields.
This property is not used directly when rendering the report. It is used as the default font for new fields.
Gets or sets the maximum number of pages allowed for a report.
This property is useful if you want to limit the maximum number of pages in a report.
For example, you may write a report designer with a preview window that shows only the first
five pages of a report.
Setting this property to zero allows reports of any length.
You can also limit the size of reports by setting the
property.
Specifies whether the control should handle Windows messages while rendering reports.
Setting this property to true allows users to resize forms, click buttons, etc. while reports are
being generated. This makes applications more responsive, and is necessary if you want to provide a
"Cancel Report" button (otherwise users wouldn't be able to click the button until the report was done).
Setting this property to false will cause reports to render slightly faster.
The code below implements "Render" and a "Cancel" buttons attached to a component.
The "Render" button checks whether the component is busy before starting to render a report.
This is necessary because the user could click the "Render" button several times in a row, before the component got a
chance to finish rendering the report. (Calling the method while the component is busy throws an
).
The "Cancel" button checks whether the component is rendering a report and sets the
property to true.
_c1r.DoEvents = true;
private void Render_Click(object sender, EventArgs e)
{
if (_c1r.IsBusy)
{
Console.WriteLine("Cannot render now, component is busy");
}
else
{
ppv.Document = c1r.Document;
}
}
private void Cancel_Click(object sender, EventArgs e)
{
if (_c1r.IsBusy)
{
_c1r.Cancel = true;
}
else
{
Console.WriteLine("No report to cancel");
}
}
Gets or sets the VBScript that is executed when the report starts rendering.
The control also fires the event at this time.
The difference between the regular event and the VBScript property is that the handler for the regular event
belongs to the application, and should thus be used to support tasks that are independent of the report.
For example, to display a message on the main window when rendering starts.
The VBScript handler in the property belongs to the report, and will be executed regardless of the application.
For example, a report might contain a VBScript handler that resets global variables in the VBScript context
when a report starts rendering.
Gets or sets the VBScript that is executed when the report finishes rendering.
The control also fires the event at this time.
The difference between the regular event and the VBScript property is that the handler for the regular event
belongs to the application, and should thus be used to support tasks that are independent of the report.
For example, to display a message on the main window when rendering finishes.
The VBScript handler in the property belongs to the report, and will be executed regardless of the application.
For example, a report might contain a VBScript handler that resets global variables in the VBScript context
when a report starts rendering.
Gets or sets the VBScript that is executed when the report starts rendering and its source recordset is empty.
The control also fires the event at this time.
The difference between the regular event and the VBScript property is that the handler for the regular event
belongs to the application, and should thus be used to support tasks that are independent of the report.
For example, to cancel rendering reports with no data.
The VBScript handler in the property belongs to the report, and will be executed regardless of the application.
For example, a report might contain a VBScript handler that changes the value of a field when the source recordset is
empty.
Gets or sets the VBScript that is executed when a new page is created.
The control also fires the event at this time.
The difference between the regular event and the VBScript property is that the handler for the regular event
belongs to the application, and should thus be used to support tasks that are independent of the report.
For example, to update a label showing how many pages have been rendered so far.
The VBScript handler in the property belongs to the report, and will be executed regardless of the application.
For example, a report might contain a VBScript handler that updates a variable at every page break.
Gets or sets the VBScript that is executed when an error occurs.
The control also fires the event at this time.
The difference between the regular event and the VBScript property is that the handler for the regular event
belongs to the application, and should thus be used to support tasks that are independent of the report.
For example, to display a an application dialog box when an error occurs.
The VBScript handler in the property belongs to the report, and will be executed regardless of the application.
For example, a report might contain a VBScript handler that changes the value of a field when an error occurs.
Gets or sets the current page number.
This property is a global variable available to VBScript expressions.
It is automatically initialized by the control with the value 1 when a report starts rendering,
and it is automatically incremented after each page break.
This property is read-write, so you can reset it using scripts. For example, you can reset the
current page to 1 whenever a new group starts rendering.
Specifies whether to cancel generation of the current report.
Setting this property to true while a report is being generated stops the report generation process.
Any pages already created are kept in the document and can be previewed or printed by an attached
print preview control.
Gets a value that determines whether a report is currently being generated.
Use this property to determine whether the control is currently busy generating a report.
This property is especially useful when the property is set to true.
In this case, the application continues to process user input while the control generates reports,
and there is a change that the user might try to start another report before the current one is done.
Gets or sets extra data needed by the calling program.
Gets the main report that contains this subreport (null for main reports).
Gets a object that can be used to render the report to a printer or
into a print preview control.
The examples below show how you can use the property to print the report
or show it in a control.
// print the report to the default printer
_c1r.Document.Print();
// show the report in a PrintPreviewDialog
PrintPreviewDialog p = new PrintPreviewDialog():
p.Document = _c1r.Document;
p.ShowDialog();
Gets a list of objects that correspond to the pages in the report.
Using this property on large reports is not recommended as it creates images for all pages at once
and thus can exhaust system resources. Instead, use ,
and methods.
Use the method to create or refresh the page images.
Gets a object that represents content of the report.
Gets a collection with all the groups in the report.
The Groups collection contains all objects defined in the current report.
Removing a Group from the collection also removes its associated header and footer sections, as well
as any fields in those sections.
Adding a Group to the collection adds the corresponding group header and footer sections to the report.
Gets the collection of objects in the report definition.
This collection always contains at least five items, which correspond to the standard report
sections that are always present: Detail, Header, Footer, PageHeader, and PageFooter.
Gets the collection of objects in the report definition.
The object also contains a collection of fields in that section.
Gets or sets an Xml string containing the complete report definition.
This property can be used to store report definitions into databases, to place them in the clipboard,
or to copy reports from one component to another.
Gets or sets the starting outline level for the groups in this report.
By default, creates an outline based on the report groups.
The outline starts at level zero, and is visible in PDF versions of the report.
This property allows you to start the report at a custom level, which can be useful
if you are rendering multiple reports into a larger document (using C1PrintDocument for example).
You can set this property to -1 to suppress the outline.
Gets or sets the position of the first label on a partially used sheet.
This property allows you to print labels on partially used label sheets. For example,
if you have a sheet with 12 labels and have already used 5, set the LabelOffset
property to 6 in order to skip the labels that have already been used.
Gets or sets the method used to process CanGrow/CanShrink fields.
If this property is set to , fields with
or properties set to true will move fields directly
below them when they grow or shrink. Fields located below but off to the side are not moved.
If this property is set to , fields that grow or shrink will
affect all fields below, even those which are not directly under the field that was modified as a result of
CanGrow/CanShrink. (This is the Microsoft Access behavior).
For example, if fields are arranged in a grid layout and is set to
, fields within each row will remain vertically aligned when fields
above them grow or shrink.
If is set to , fields within each
column will move independently of fields in other columns, and fields within each row will not remain vertically
aligned.
Specifies whether the component should use the .NET printing support to obtain high-resolution graphics.
By default, scans the installed printers in order to
obtain a high-resolution reference object.
Set this property to false in order to bypass this process and use the
screen resolution when generating reports. This will increase report rendering
speed (in some cases) with some loss in layout accuracy.
Under certain circumstances, notably when running under Windows Services,
the .NET printing support does not work correctly, and trying to enumerate the
installed printers may cause memory allocation problems. In these situations,
setting this property to false is necessary.
Specifies whether the component should ignore script errors by default.
When the script interpreter finds an error in a script or expression, the
component raises the event. This property specifies
the default value for the Handled parameter in that event.
If IgnoreScriptErrors is set to true, script errors are ignored
by default (the Handled parameter is initialized to true).
If IgnoreScriptErrors is set to false, script errors throw
exceptions by default (the Handled parameter is initialized to false).
In either case, the event handler may override
the default by changing the value of the Handled parameter.
Specifies whether script objects added with the
method should be exposed to subreports.
Gets or sets the number of detail records to render per page or group.
This is useful when printing forms that must have a specific number of rows.
If the number of records is greater than the value specified, group or page breaks
are added to limit the number of records rendered in each group of detail sections.
If the number of detail records is smaller than the value specified, blank
records are added so the group of detail sections has the specified number of records.
If this property is set to zero (the default value), then it has no
effect.
Gets the height of the remaining area available for sections on the current page.
This property can only be used while the report is being rendered (i.e. when is true),
at other times a value of -1 is returned.
Note that if used in OnPrint/OnFormat scripts, this value does NOT yet account for the current section.
Here is an example of code which can be used in the detail section's OnFormat script
to determine whether the current detail section will be the last one printed on the page
(the test checks that the current section will fit onto the page while the next section won't):
h = Detail.RenderHeight
ah = Report.AvailableHeight
if (h < ah) and (2 * h > ah) then
Detail.BackColor = RGB(255, 0, 0) ' last on page
else
Detail.BackColor = RGB(255, 255, 255)
endif
Type of delegate used to specify custom handlers for script editors.
When component is used with a
control, the property grid uses custom type editors to provide user interface elements
for editing scripts, statements, and data source properties.
This delegate allows report designer applications to provide their own user
interface for editing these elements.
For examples of how these delegates are used, please see the source code
for the C1ReportDesigner application, included with the C1Report Designer
Edition.
Type of delegate used to specify custom handlers for data source editors.
When component is used with a
control, the property grid uses custom type editors to provide user interface elements
for editing scripts, statements, and data source properties.
This delegate allows report designer applications to provide their own user
interface for editing these elements.
For examples of how these delegates are used, please see the source code
for the C1ReportDesigner application, included with the C1Report Designer
Edition.
Represents the method that will handle , ,
, , ,
, and events.
Provides data for , , ,
, , , and
events.
The current page.
The current section.
that caused the error.
This property is only used with the event.
Gets or sets a value that indicates whether the component should throw the
that was detected or whether it should ignore the error and continue rendering the report.
This property is only used with the event.
Gets or sets the text that will be used as an outline entry.
This property is only used with the event.
Represents the method that will handle the event.
Provides data for event.
Reference to a that is about to be displayed.
Gets or sets a value that determines whether the component should display the parameters dialog.
Gets the collection of parameters defined by the report.
TODO
Represents the method that will handle the event.
Class that contains report metadata.
Reports may include general information such as a title, author, and keywords.
Such global information about the document itself (as opposed to its content or
structure) is called metadata, and is intended to assist in cataloguing and
searching for reports and report definitions in external databases.
Clears the object.
Returns a copy of this object.
A copy of this object.
Returns a string that represents the current object.
Returns a string that represents the current object.
Gets or sets the name of the person that created the report.
Gets or sets the title of the report.
Gets or sets the subject of the report.
Gets or sets keywords associated with the report.
Gets or sets the name of the application that created the report.
Represents a local context for script evaluation and execution.
Retrieves an object by its name.
The name of the object to get.
The named object.
Tests whether the specified name exists in the current context.
If a certain name is defined by the context (i.e. this method returns true),
the named object will be retrieved from the context even if a similarly named object
already exists.
The name to test.
True if the name exists in the context, false otherwise.
Specifies the section type, which is equivalent to a the index of a object
in the control's collection.
Use the members of this enumeration to set the value of the and
properties.
Undefined. This setting indicates the field doesn't belong to any sections and should not be rendered.
Detail section: repeated for every record in the source recordset.
Report header section: appears once, in the beginning of the report.
Report footer section: appears once, in the end of the report.
Page header section: appears at the top of every page, subject to the setting of the
property.
Page footer section: appears at the bottom of every page, subject to the setting of the
property.
Group header section: appears before level-one groups.
Group footer section: appears after level-one groups.
Group header section: appears before level-two groups.
Group footer section: appears after level-two groups.
Group header section: appears before level-three groups.
Group footer section: appears after level-three groups.
Group header section: appears before level-four groups.
Group footer section: appears after level-four groups.
Represents a report band.
Each Section object contains a collection of fields objects that display individual data items
within the section.
Every report contains the following sections:
A detail section.
A report header and a report footer section.
A page header and a page footer section.
A group header and a group footer section for each object in the report.
The total number of sections in a report is therefore 5 + 2 * Groups.Count. Sections cannot
be added and removed from reports directly. The number of sections is a function of the number of groups.
Although sections cannot be removed, they can be hidden by setting their property
to false.
Gets or sets the name.
The section name can be used as an index into the control's collection.
Section names are also used to identify fields in VBScript expressions.
Duplicate and empty section names are allowed, but should be avoided if you plan to use the section names
in scripts or as indexers.
Specifies whether the will be rendered in the report.
Returns the type (e.g., PageHeader, Detail).
Returns a collection of all fields in this .
The Fields collection contains all objects defined in the current section.
When you add a field to a section's Fields collection, the field is automatically assigned to the
section that owns the collection. For example, the code below adds a field to the Detail section:
_c1r.Sections.Detail.Fields.Add("new field", "CompanyLogo", rc);
Gets or sets extra data used by the calling program.
Gets the object that contains this .
Gets or sets the height, in twips.
The height of a section should be large enough to accommodate all fields in the section.
The Report Designer automatically adjusts section heights when fields are added, moved, or resized.
Returns the height of the section after the and
properties have been applied to the section.
When a section grows or shrinks, its property does not change.
If you need to retrieve the actual height that will be used for rendering the section
(for example, while handling the event), use the
property instead.
Specifies whether the should be kept together on a page.
The and objects also have KeepTogether properties.
The object's property works across sections.
It determines whether group headers should be kept together with their first detail section or whether entire
groups should be kept together on a page.
The object's property determines whether the
field should be rendered on a single page or whether it is allowed to be split across page breaks.
Specifies whether page breaks should be inserted before and/or after the section is rendered.
Specifies whether the Section height should be automatically increased to fit its contents.
You can use the and properties to control the
appearance of report sections and fields.
For example, if you set both properties to true, a section or field automatically adjusts
vertically to print or preview all the data it contains.
Sections grow and shrink vertically across their entire width.
When a section grows or shrinks, its property does not change.
To retrieve the actual rendering height, use the property.
You can make fields grow or shrink to match the size of the section by setting their
property.
Specifies whether the height should be reduced when one or more fields shrink.
You can use the and properties to control the layout of
report sections and fields.
For example, if you set both properties to true, a section or field automatically adjusts vertically
to print or preview all the data it contains.
When a section grows or shrinks, its property does not change. To retrieve the
actual (adjusted) height, use the property.
You can make fields grow or shrink to match the size of the section by setting their
property.
For group header and group footer sections only,
gets or sets a value indicating whether the current section should be repeated
at the top of each page. The default is false.
This property only applies to group header and group footer sections.
Set this value to true to repeat the group header page at the top of every page, before the detail sections.
If you have multiple groups, all group header sections that have the Repeat property set to true will
be rendered at the top of each page.
For master report's footer sections only, gets or sets a value
indicating whether the current section should print at the bottom
of the page immediately above the page footer, rather than right
below the detail. The default is false.
This property is ignored for non-footer sections or for footers
of sub-reports.
Gets or sets the background color for this .
Gets or sets a string containing VBScript code to be executed before the is formatted.
This property contains VBScript instructions to be executed before the fields in the section
are calculated. When this script is executed, the recordset already holds the data that will be displayed
in the section, but the field values have not been updated yet.
Use this event to assign values to fields before they are calculated, so the new values will be taken
into account when the control calculates the field's size and position when the or
properties are set to true.
If you want to set field properties based on the field's current value, use the
property instead.
Gets or sets a string containing VBScript code to be executed before the is printed
(after it is formatted).
This property contains VBScript instructions that get executed after the fields in the section
have been calculated.
Collection of the objects.
Copies the elements of the collection to an , starting at a particular array index.
The one-dimensional that is the destination of the elements
copied from collection. (The array must have zero-based indexing).
The zero-based index in array at which copying begins.
Determines whether the collection contains a specific .
The object.
True if the collection contains specified section; false otherwise.
Returns a section from a collection.
The index parameter may be an integer between zero and -1.
Returns a section from a collection.
Returns a section from a collection.
The name parameter may be a string containing a section name.
Returns a reference to the detail section of the report.
This property is equivalent to this[SectionTypeEnum.Detail].
Returns a reference to the report header section.
This property is equivalent to this[SectionTypeEnum.Header]
Returns a reference to the report footer section.
This property is equivalent to this[SectionTypeEnum.Footer].
Returns a reference to the page header section of the report.
This property is equivalent to this[SectionTypeEnum.PageHeader].
Returns a reference to the page footer section of the report.
This property is equivalent to this[SectionTypeEnum.PageFooter].
Returns the number of elements in the collection.
The class does not have Add or Remove methods.
That is because the number of sections in a report is determined by then number of groups.
To add or remove sections from the report, you need to add or remove groups.
Abstract base class for shapes rendered by report fields
(see and ).
Initializes a new instance of the class.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Creates a copy of the current object.
Property is not copied and value of property
is null.
The newly created object.
Gets the type of the current shape.
Gets the owning the current object.
Abstract base class for and classes.
Initializes a new instance of the class.
Represents a line shape in a .
Initializes a new instance of the class.
Initializes a new instance of the class.
Specifies the line slant to use.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Overridden. Gets .
Gets or sets a value specifying how the line should be drawn within the field.
Abstract base class for and types.
Initializes a new instance of the class.
Represents an isosceles triangle shape in a .
Initializes a new instance of the class.
Overridden. Gets .
Represents a rectangular triangle shape in a .
Initializes a new instance of the class.
Overridden. Gets .
Represents a rectangle shape in a .
Initializes a new instance of the class.
Overridden. Gets .
Represents an ellipse shape in a .
Initializes a new instance of the class.
Overridden. Gets .
Abstract base class for and classes.
Initializes a new instance of the class.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets the angle, measured in degrees, clockwise from the X axis
to the first side of the sector defining the current shape.
Gets or sets the angle, measured in degrees, clockwise from
to the second side of the sector defining the current shape.
Represents an arc shape in a .
Initializes a new instance of the class.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Overridden. Gets .
Gets or sets a value indicating whether the current arc should be closed
(i.e. the start and end points of the arc should be connected by a straight line).
The default value of this property is false.
Represetns a pie shape in a .
Initializes a new instance of the class.
Overridden. Gets .
Encapsulates a object and provides get/set access to the font properties.
Initializes a new instance of the class.
The object used to initialize the FontHolder.
Gets a string that represents this .
A string that represents this .
Gets or sets the name of the encapsulated object.
Gets or sets the of the encapsulated object.
Gets or sets a value that indicates whether the encapsulated is bold.
Gets or sets a value that indicates whether the encapsulated is italic.
Gets or sets a value that indicates whether the encapsulated is underlined.
Gets or sets a value that indicates whether the encapsulated has a horizontal line
through the text.
Gets or sets the GDI character set used by the encapsulated .
For internal use.
For internal use.
For internal use.
Encapsulates an object and provides methods for loading images from
image files or from binary database fields.
A object may contain an unbound image (from a file or URL),
or the name of a database field that contains images.
For internal use.
Gets the default path for image and other files.
Gets a string that represents this .
A string that represents this .
Gets a value that indicates whether this is bound to a database field that contains images.
Gets a value that indicates whether this contains an image URL.
Gets a value that indicates whether this is empty.
Gets the name of the database field from which this will load images.
Gets the loaded by this .
Gets the URL that contains the loaded by this .
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
Extends the design mode behavior of a .
Initializes the designer with the specified component.
The to associate the designer with.
This component must always be an instance of, or derive from, .
Gets the collection of associated with this designer.
Contains localizable design-time strings.
The base class for design-time editors for class names of forms derived from a certain base form type.
When overridden in a derived type, should return the name of the base form type.
The editor context.
The service provider.
The instance associated with this editor.
The base form type name.
Gets the editor style.
The editor context.
The editor style.
Edits a value.
The editor context.
The service provider.
The value to edit.
For internal use only.
For internal use.
For internal use.
Represents a 's native C1DB format .
The abstract base class describing a supported export format.
All export providers describing specific formats (such as PDF or HTML) derive from this class.
For the list of all available export providers, see .
Tests whether the specified object represents a document that can be exported
by an associated with the current export provider
(see ).
The default implementation of this method returns false.
The object (document) to test.
true if the associated can export the specified object,
false otherwise.
Tests whether documents of the specified type can be exported
by an associated with the current export provider
(see ).
Note that if just the type is not enough to determine whether a document
of that type can be exported (e.g. an array of objects can be exported
by some exporters only if all objects in that array are images),
this method returns false.
Use method to get a definitive value.
The document type to test.
true if the associated can export documents of the specified type,
false otherwise.
Tests whether the associated with the current export provider
can handle the specified type of document pages' range.
The default implementation of this method returns true if the specified range type
is , false otherwise.
The type of range to test.
true if the associated can handle the specified output range, false otherwise.
Creates a new Exporter object.
When overridden in a derived class, returns an instance of a specialized class derived from .
Returns the newly created exporter.
Gets the format key, which is an arbitrary string that should uniquely identify
the current export provider/format.
The default implementation returns the current 's type name.
Gets a short description of the current export format.
Gets the default filename extension for the current export format.
Gets a value indicating whether export to stream is supported by the current format.
Gets a value indicating whether the associated
can show a dialog allowing the user to edit the export options.
Gets the type of form which is used to edit the export options by default.
Gets the combination of flags indicating which fields of the class
are supported by the current export format.
For -specific export providers,
gets the associated with the current provider.
For other providers, returns null.
Tests whether the specified object represents a document that can be exported
by a .
The object (document) to test.
true if is an instance of
or , false otherwise.
Tests whether documents of the specified type can be exported
by a .
The type to test.
true if is
or , false otherwise.
Creates a new instance of .
The newly created instance.
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 1.
Gets a short description of the C1DX export format.
Gets the default filename extension for the current export format.
This implementation returns "c1db".
Gets a value indicating whether export to stream is supported by the current format.
This implementation returns true (export to stream is supported).
Gets the type of form which is used to edit the export options by default.
Gets the combination of flags indicating which fields of the class
are supported by the current export format.
Represents an object that can be used to export a document to C1DB format.
The abstract base class for and classes.
The abstract base class for and classes.
The abstract base class for all exporter classes.
An instance of an derived class is used to export a document.
Initializes a new instance of the class.
Tests whether can be previewed.
This (base) implementation uses FindExecutable API to find an appropriate executable,
and returns a value indicating whether it has been found or not.
If you override this, you must also override .
true if the output file can be previewed, false otherwise.
Previews .
This (base) implementation uses System.Diagnostics.Process.Start()
to open the output file.
Override this if you override .
Gets the file name (with path) for the file containing the specified page.
Used only for export formats that save a page per file (e.g. TIFF).
The 1-based page number.
The output file name.
Exports a page of a document represented by a .
The representing the page to export.
The containing information about the .
The 1-based page number.
true if represents the first page of the document, false otherwise.
Resets the internal state of the exporter.
Resets the internal state of the exporter and all its public properties.
Called after the property has been changed.
If you override this, make sure this base method also gets called.
Processes (exports) all pages in the range to be exported.
Indicates whether page metafiles of types and
should be converted to type before exporting.
The base implementation returns false.
Performs export to a disk file or to a stream.
The destination (file or stream) is determined by which of the properties
( or ) is non-null
when this method executes.
Makes sure the has been generated if it is an instance
of the or of the class.
Copies the properties of the current exporter to corresponding
user-editable options of the specified export options form.
Can be overridden in a derived class to handle format-specific options.
The object to copy the properties to.
Copies the options from the specified export options form
to corresponding properties on the current exporter.
Can be overridden in a derived class to handle format-specific options.
The object to copy the options from.
Exports the object specified by the property on the current exporter
to the specified file.
The name of the output file.
Exports the object specified by the property on the current exporter
to the specified .
Note that some export formats do not support exporting to streams.
Test the value returned by the property
on prior to calling this method.
Stream object to store results of export.
Displays a dialog that allows the user to edit the export options.
true if the dialog was displayed successfully and the user pressed OK, false otherwise.
Occurs periodically during export.
Allows to show progress and give the end user the ability to cancel the operation.
Gets the list of files which were generated by the call to .
Typically exporters produce a single file (e.g. , ),
but some (like and ) may produce several files all of which
can be then accessed through this property.
Gets or sets the object associated with the
assigned to the current exporter.
Gets an instance of a class derived from
describing the export format associated with the current exporter.
That instance can be used to retrieve static information about the current export format
such as format description or default extension.
Gets or sets the object representing the document that will be exported
by the current exporter's or methods.
Gets or sets a value indicating whether the exported document should be opened
after exporting it to a disk file (using the method).
The application used to open the file is determined by the OS shell.
Gets or sets a value indicating whether the options dialog should be shown to the user
before exporting the document.
Gets or sets the range of pages that is to be exported.
Specifies the object used by export.
For example, that can be used to convert
or
metafiles to .
If this property is null, the screen device context is used.
Gets or sets the type of form that is used to edit export options.
That form is shown when the or the method is called
if is true.
The form's type must be assignable to the type specified by the
property.
Gets or sets the type name of form that is used to edit export options.
That form is shown when the or the method is called
if is true.
The form's type must be assignable to the type specified by the
property.
Gets or sets the type of form that is used to edit the fields of class.
That form can be invoked from the export options form ().
The form's type must be assignable to .
Gets or sets the type of form that is used to enter the export output range.
That form can be invoked from the export options form ().
The form's type must be assignable to .
Overridden.
Tests whether can be previewed.
Calls the base implementation, if that returns false,
tries to create an instance of C1.Win.C1Preview.C1PrintPreviewDialog,
returns true if succeeds.
true if the output file can be previewed, false otherwise.
Overridden.
Previews .
Tries to preview the output file, either using the OS shell or
an own instance of C1.Win.C1Preview.C1PrintPreviewDialog
if there is no shell association on the current system.
Not supported for this class.
Resets the internal state of the exporter and all its public properties.
Copies the properties of the current exporter to corresponding
user-editable options of the specified export options form.
The object to copy the properties to.
Copies the options from the specified export options form
to corresponding properties on the current exporter.
The object to copy the options from.
Performs export to a disk file or to a stream.
Gets a value that determines the format used to save the document.
Gets or sets a value indicating whether to embed TrueType fonts used in the source document, in the produced document.
Note that this property cannot be set if gets false.
The default value depends on the document being exported.
Gets a value indicating whether font embedding in the exported document
can be changed. Gets false if the source document cannot be regenerated
with different font embedding settings.
Gets a value used by this exporter.
If it is different from the document's own value, the document will be regenerated
during export.
Copies the properties of the current exporter to corresponding
user-editable options of the specified export options form.
The object to copy the properties to.
Overridden.
Gets a value that determines the format used to save the document.
This implementation returns .
Gets .
The abstract base class describing an export format that uses one of
-specific classes
to perform export. All derived export formats only support
export of objects.
Creates a new instance of the class.
Tests whether the specified object represents a document that can be exported by the current export provider.
This implementation returns true if the passed object is a ,
false otherwise.
The object (document) to test.
true if the object represents a document that can be exported, false otherwise.
Tests whether documents of the specified type can be exported by the current export provider.
The type to test.
true if is , false otherwise.
Gets a value determining the format
of the export file produced by the current export provider.
Gets the default filename extension for the current export format.
Gets a short description of the current export format.
Specifies the preferred ordinal of the current export format in "save as..." and similar dialogs.
A value of -1 indicates that the export format should not be listed at all.
Gets the associated with the current provider.
Describes export of a
to drill-down HTML ().
Creates a new instance of the class.
Describes export of a
to paged HTML ().
Creates a new instance of the class.
Describes export of a
to HTML (,
or ).
Creates a new instance of the class.
Overridden. Creates a new instance of the class.
Overridden. Gets the type of form which is used to edit the export options by default.
This implementation returns .
Describes export of a
to PDF with embedded fonts ().
Creates a new instance of the class.
Describes export of a
to PDF ().
Creates a new instance of the class.
Describes export of a
to protected PDF ().
Creates a new instance of the class.
Obsolete: Describes export of a
to PDF ().
Creates a new instance of the class.
Describes export of a
to RTF ( or ).
Creates a new instance of the class.
Overridden. Creates a new instance of the class.
Overridden. Gets the type of form which is used to edit the export options by default.
This implementation returns .
Describes export of a
to field-based RTF ().
Creates a new instance of the class.
Describes export of a
to plain text ().
Creates a new instance of the class.
Overridden. Creates a new instance of the class.
Overridden. Gets the type of form which is used to edit the export options by default.
This implementation returns .
Describes export of a
to single-page text ().
Creates a new instance of the class.
Describes export of a
to compressed metafile ().
Creates a new instance of the class.
Describes export of a
to Microsoft Excel ().
Creates a new instance of the class.
Describes export of a
to OpenXml Excel ().
Creates a new instance of the class.
Describes export of a
to TIFF image ().
Creates a new instance of the class.
Overridden. Creates a new instance of the class.
Overridden. Gets the type of form which is used to edit the export options by default.
This implementation returns .
Provides export of a to TIFF images.
Provides export of a to an external format
using one of -specific classes.
Creates an instance of determined by .
The file to create the filter for.
The filter created.
Resets the internal state of the exporter and all its public properties.
Indicates whether page metafiles of types
and
should be converted to type before exporting.
This implementation returns false.
Resets the internal state of the exporter.
Gets the base export file format supported by the current exporter.
The actual format () may either be the same,
or may be a specific variant of that format.
E.g. if this property is ,
may be .
Gets the actual export file format supported by the current exporter.
Gets an instance of
that describes the supported by the current exporter.
Initializes a new instance of the class.
For internal use only.
Gets or sets whether the TIFF document should be saved in monochrome format.
The default value for this property is true, which results in much smaller documents that are compatible
with fax machines (the compression used is CompressionCCITT4).
Set this property to false to generate color documents which use LZW compression but are substantially
larger than monochrome documents (often 100 times larger using the same resolution).
Provides export of a to HTML.
Initializes a new instance of the class.
Overridden.
Gets a value determining the format
of the export file produced by the current export provider.
Depending on and properties,
returns ,
or .
Gets or sets a value indicating whether to create table-based HTML
(see ).
If this property is true, and
are ignored.
Gets or sets a value indicating whether to create paged HTML
(see ).
If both this and are true,
this property takes precedence.
Gets or sets a value indicating whether to create drill-down HTML
(see ).
If both this and are true,
takes precedence.
Provides export of a to RTF.
Initializes a new instance of the class.
Overridden.
Gets a value determining the format
of the export file produced by the current export provider.
Depending on property,
returns or .
Gets or sets a value indicating whether absolute positioning of objects
is used in the exported RTF file
(see ).
Provides export of a to plain text.
Initializes a new instance of the class.
Overridden.
Gets a value determining the format
of the export file produced by the current export provider.
Depending on property,
returns or .
Gets or sets a value indicating whether report is exported as a single page
(see ).
Represents a 's native C1MDX format .
Tests whether the specified object represents a document that can be exported
by a .
The object (document) to test.
true if is an instance of
, false otherwise.
Tests whether documents of the specified type can be exported
by a .
The type to test.
true if is
, false otherwise.
Creates a new instance of .
The newly created instance.
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 1.
Gets a short description of the C1DX export format.
Gets the default filename extension for the current export format.
This implementation returns "c1dx".
Gets a value indicating whether export to stream is supported by the current format.
This implementation returns true (export to stream is supported).
Gets the type of form which is used to edit the export options by default.
Gets the combination of flags indicating which fields of the class
are supported by the current export format.
Represents an object that can be used to export a document to C1MDX format.
Performs export to a disk file or to a stream.
Gets .
Represents the default options form for C1D/C1DX export modules.
Represents a form for editing the export options used by an .
Base class for all custom forms in C1Preview.
Initializes a new instance of the class.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Creates a new instance of a -derived class.
The exporter to use.
The custom form type.
The default form type.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Gets the associated exporter.
Gets the associated export provider.
Gets the document that is to be exported.
Gets or sets a value indicating whether the resulting document
should be opened using the default system viewer.
Gets or sets the document info.
Gets or sets the range of pages to be exported.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Gets or sets a value indicating whether to embed embeddable fonts used in the document.
Gets or sets a value indicating whether to enable the "embed fonts" checkbox.
Represents the default options form for C1D/C1DX export modules.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Represents the default options form for -specific
plain text export modules.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Represents the default options form for -specific
plain text export modules.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Represents the default options form for -specific
RTF export modules.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Represents the default options form for -specific
HTML export modules.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Specifies the various modes of accounting for border thickness when
laying out the objects in a document.
Whole border is considered to be part of the object.
This is the default behavior of objects in .
The inner 1/2 of border thickness is considered to be part of the object,
the outer 1/2 of border is considered to be outside of the object's space.
This is the default behavior of objects in (same as in MS Access).
Border thickness is not taken into account at all when calculating objects'
sizes and layout. Borders are drawn centered on objects' bounds.
Defines the compatibility options for C1PrintDocument.
Contains properties specifying compatibility with
previous versions of C1PrintDocument.
Copies properties from another object into this object.
The source object, properties of which are copied.
Resets properties of this object to default values.
Gets or sets the value indicating whether RTF objects fill the background with
white, or use the specified background color. The default is false.
Gets or sets a value indicating whether the widths of page headers and footers
should be equal to the sum of the widths of all page columns. The default is false.
Set this property to true to improve compatibility with C1Report.
Gets or sets a value indicating whether absolute coordinates of top-level
objects in the document are relative to page margins or to physical page
bounds.
The default value of this property is false, which indicates the
traditional behavior with coordinates relative to page edges.
If set to true, coordinates are considered relative to page margins.
For instance, if this property is false (default), all page margins are 1 in,
and a top-level object's X coordinate is specified as ".5in", the object
would be located 0.5in from the left edge of the page - i.e. in the middle
of the left page margin.
If this property is set to true, the same object would be located 0.5in
to the right of the left page margin - 1.5in from the left edge of the page.
Gets or sets a valud specifying how borders affect the layout of objects in a document.
See for details.
The default value is .
Specifies whether images in a document dictionary are kept as Image objects.
Set this property to false to save images as raw data to optimize memory usage.
The default value is true.
Internal use only.
Internal use only.
Determines whether the specified Object is equal to the current Object.
The Object to compare with the current Object.
true if the specified Object is equal to the current Object; otherwise, false.
Serves as a hash function for a particular type.
A hash code for the current Object.
Represents a 's native C1D format .
Tests whether the specified object represents a document that can be exported
by a .
The object (document) to test.
true if is an instance of
or , false otherwise.
Tests whether documents of the specified type can be exported
by a .
The type to test.
true if is
or , false otherwise.
Creates a new instance of .
The newly created instance.
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 1.
Gets a short description of the C1D export format.
Gets the default filename extension for the current export format.
This implementation returns "c1d".
Gets a value indicating whether export to stream is supported by the current format.
This implementation returns true (export to stream is supported).
Gets the type of form which is used to edit the export options by default.
Gets the combination of flags indicating which fields of the class
are supported by the current export format.
Represents an object that can be used to export a document to C1D format.
Copies the properties of the current exporter to corresponding
user-editable options of the specified export options form.
The object to copy the properties to.
Overridden.
Gets a value that determines the format used to save the document.
This implementation returns .
Gets .
Represents a form for editing the export options used by an
when exporting to Open XML DOCX format.
Represents a form for editing the export options used by an .
Represents a form for editing the export options used by a .
Can be used to update controls depending on Paginated property.
Performs additional initialization.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
The "preserve pagination" checkbox.
The "fixed positioning" checkbox.
The "Open XML" checkbox.
Gets a value indicating whether export that does not preserve pagination of the original document should be allowed.
Gets or sets a value indicating whether the export should preserve pagination of the original document.
Gets or sets a value indicating whether objects within the document should have absolute fixed positions,
or added to the document flow if possible.
Gets or sets a value indicating whether the export should use Open XML file format.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Gets or sets a value indicating whether to use canvases in the exported document.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Represents the default options form for export modules that do no have any custom options.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Represents a form for editing the export options used by an
when exporting to Open XML XLSX format.
Represents a form for editing the export options used by an .
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Gets or sets the prevailing type of content in the source document.
Gets or sets the font scaling factor.
Gets or sets the tolerance.
Gets or sets a value indicating whether each page of the source document
should be exported as a separate sheet.
Gets or sets a value indicating whether only data should be exported.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Represents the standard form used to edit the
collection of a .
Describes the base form for tags input.
Initializes a new instance of the class.
When overridden in a derived class, should show the tags input dialog,
and return a value indicating whether the user accepted the dialog.
The owner of the collection to edit.
true if the user accepted the dialog, false otherwise.
Shows the tags input dialog, returns a value indicating whether the user
accepted the dialog.
The owner of the collection to edit.
true if the user accepted the dialog, false otherwise.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Initializes a new instance of the class.
Shows the tags input dialog,
returns a value indicating whether the user accepted the dialog.
The owner of the collection to edit.
true if the user accepted the dialog, false otherwise.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Gets the which is the owner of the tags that are edited.
Provides data for page-related events such as
and .
Gets the index of the first page associated with this event.
Gets the count of pages associated with this event.
Represents a method that can handle page-related events of a such as
and .
The source of the event.
A that contains the event data.
Provides data for item-related events such as
.
Gets the object associated with this event.
Represents a method that can handle item-related events such as
.
The source of the event.
A that contains the event data.
Provides data for the event.
Gets the report or document represented by the .
Represents a method that can handle ItemLoaded event of .
The source of the event.
A that contains the event data.
Specifies the type of temporary storage used by .
Store document items in memory.
Store document items on disk.
Represents a multi-document - a sequence of several documents that have
common page numbering, and can be handled (e.g. printed or exported)
together as a single large document.
Allows creating very large documents without running out of memory.
Initializes a new instance of the type.
Overridden. Disposes the current object.
Builds the outline tree for the current multi-document, merging the multi-document's own
outlines () and outline trees of documents and reports
contained within the multi-document.
For details, see the remarks section of the property.
The combined outline for the multi-document.
Clears the pages and other info created during document generation.
This method does not clear the document structure/content though.
Clears the current C1MultiDocument.
Loads the current document from a stream.
The stream from which to load the document.
Loads the current document from a file.
The source file name.
Saves the current document to a stream.
The target stream.
Saves the current document to a disk file.
The target file name.
Generates the current C1MultiDocument.
Gets a that represents the specified page.
The page index (0-based).
A value indicating whether to render input (preview forms) controls.
The smoothing mode to use.
The representing the specified page, or null if index was invalid.
Gets a representing the specified page.
The page index (0-based).
The representing the specified page, or null if index was invalid.
Retrieves extended information about a page with the specified index.
The 0-based index of the target page.
OUT: 0-based index of the document item () that contains the target page.
OUT: 0-based index of the target page within the document item that contains it (indicated by ).
OUT: The logical page number within the current document.
true if is valid, false otherwise.
For internal use only.
Sets the temporary storage type used by the current multi-document.
Note that document items are actually moved from old storage to new by this method.
The new storage type to use.
The temporary directory to use if is StorageType.Disk.
Sets the temporary storage type used by the current multi-document.
Note that document items are actually moved from old storage to new by this method.
The new storage type to use.
Exports the current multi-document to a disk file.
The output file name. The file extension determines the export format.
The range of pages to export (use null to export all pages).
Flag indicating whether to show the progress dialog.
Exports the current multi-document to a disk file.
The output file name. The file extension determines the export format.
Flag indicating whether to show the progress dialog.
Exports the current multi-document to a disk file.
The output file name. The file extension determines the export format.
Exports the current multi-document to a stream.
The destination stream.
The export provider. Use any of the static export providers available on
the class.
Flag indicating whether to show the progress dialog.
Exports the current multi-document to a stream.
The destination stream.
The export provider. Use any of the static export providers available on
the class.
Exports the current multi-document to a disk file.
The output file name. The file extension determines the export format.
The export provider. Use any of the static export providers available on
the class.
The range of pages to export (use null to export all pages).
Flag indicating whether to show the progress dialog.
Exports the current multi-document to a stream.
The destination stream.
The export provider. Use any of the static export providers available on
the class.
The range of pages to export (use null to export all pages).
Flag indicating whether to show the progress dialog.
Prints the current document with default printer settings,
not showing the print progress dialog.
Prints the current document with specified printer settings,
not showing the print progress dialog.
The printer settings to use.
Prints the current document with specified printer settings,
optionally showing the print progress dialog.
The printer settings to use.
Flag indicating whether to show the print progress dialog.
Prints a range of pages within the current document with specified printer settings,
not showing the print progress dialog.
The printer settings to use.
The range of pages to print (use null to print all pages).
Prints a range of pages within the current document with specified printer settings,
optionally showing the print progress dialog.
The printer settings to use.
The range of pages to print (use null to print all pages).
Flag indicating whether to show the progress dialog.
Prints a range of pages within the current document with specified printer and default page settings,
not showing the print progress dialog.
The printer settings to use.
The default page settings to use.
The range of pages to print (use null to print all pages).
Prints the current document with specified printer and default page settings,
optionally showing the print progress dialog.
The printer settings to use.
The default page settings to use.
Flag indicating whether to show the progress dialog.
Prints a range of pages within the current document with specified printer and default page settings,
optionally showing the print progress dialog.
The printer settings to use.
The default page settings to use.
The range of pages to print (use null to print all pages).
Flag indicating whether to show the progress dialog.
Shows the standard print dialog, allowing the user to print the current document.
true if the document was printed, false otherwise.
Shows the standard print dialog, allowing the user to print the current document.
The printer settings to use.
The list of selected page numbers.
If this parameter is not null, selection option is enabled in the dialog.
Indicates whether to show print progress.
true if the document was printed, false otherwise.
Gets or sets the name of the document (used to identify documents in print tasks and so on).
Gets or sets the type of metafiles created by the current document.
The default is null (the property is not defined at the multi-document level).
Gets or sets a value indicating whether text in the current document
is rendered using GDI+ text API.
The default is null (the property is not defined at the multi-document level).
Gets or sets a value indicating whether hyperlinks in the report are colorized.
This property only affects items of the multi-document.
The default is null (the property is not defined at the multi-document level).
Gets the containing outline nodes specified
for the multi-document.
Note that this collection does not include outlines of documents and reports
contained within this multi-document. Use the method
to build the complete outline tree for the multi-document.
See remarks for more details.
The resulting outline for the multi-document - the one that is built by the
method, and what is shown for instance in the preview -
is comprised of outline nodes defined in the multi-document's own Outlines collection,
and of outlines of documents and reports represented by the multi-document's items.
The multi-document's own Outlines collection is processed first, and nodes from that
collection are included in the resulting outline. If a node is also specified as the
of a contained
(i.e. the two nodes reference the same object), the whole outline of the document or report
represented by that item is inserted into the resulting outline.
Depending on the value of the multi-document item's ,
the outline of the document or report is either nested within the outline node, or replaces it.
Outlines of documents and reports represented by items that are not included
in the multi-document's Outlines collection
(via the item's property as described above)
are automatically appended to the resulting outline sequentially.
Gets a value indicating whether the current C1MultiDocument
has been changed since it was last generated.
Gets a value indicating whether the current C1MultiDocument
is empty, i.e. has no objects
with data.
Indicates whether the document is currently being generated.
Gets the temporary storage type used by the current multi-document.
Gets the temporary directory used by the current multi-document if its
temporary storage type is .
Gets the collection of objects
containing documents included in the current C1MultiDocument.
Gets or sets a value indicating whether the current
should handle Windows messages while generating.
The default value is false.
Setting this property to true allows users to resize forms, click buttons, etc. while documents are
being generated. This makes applications more responsive, and is necessary if you want to provide a
"Cancel" button to stop the document generation (otherwise the user wouldn't be able to click the
button until the generation is complete).
Setting this property to false will cause documents to generate slightly faster.
The code below implements "Generate" and "Cancel" buttons attached to a .
The "Generate" button checks whether the document is busy before starting to generate it.
This is necessary because the user could click the "Generate" button several times in a row, before the document got a
chance to finish generating. (Calling the method while the component is busy throws an
exception.)
The "Cancel" button checks whether the document is currently generating, and sets the
property to true if it is.
_doc.DoEvents = true;
private void Generate_Click(object sender, EventArgs e)
{
if (_doc.BusyState != BusyStateEnum.Ready)
Console.WriteLine("Cannot generate now, document is busy");
else
_doc.Generate();
}
private void Cancel_Click(object sender, EventArgs e)
{
if (_doc.BusyState != BusyStateEnum.Ready)
_doc.Cancel = true;
else
Console.WriteLine("Document is not generating, nothing to cancel");
}
Gets or sets a value indicating whether to cancel the generation of the current document.
Note that this property is useful only if
is set to true.
Setting this property to true can only be done while the current document is
being generated (i.e. the value of the property is
equal to ). An attempt to set this property
to true when the document is not being generated will cause an exception.
Gets the current busy state of the current document.
Gets the total number of pages in the current multi-document.
Gets or sets arbitrary data associated with the current document.
Occurs when the document generation is started.
Occurs when the document generation is ended.
Occurs periodically during document generation.
Allows to provide progress indication and the ability to cancel generation to the user.
Occurs when the property value has changed.
Occurs when one or more pages were added to the current multi-document.
Occurs when one or more pages within the current multi-document were changed.
Occurs when all pages within the current multi-document were removed.
Occurs when the generation of a document or report associated with a is about to start.
Occurs when the generation of a document associated with a has completed.
On some systems garbage collection does not always work correctly without explicit calls to GC.
Use this event to call GC.Collect() to ensure that multi-document generation does not cause an out of memory exception.
Occurs when a is about to be added to the current
multi-document's collection.
Occurs when a has been added to the current
multi-document's collection.
Occurs when a is about to be removed from the current
multi-document's collection.
Occurs when a has been removed from the current
multi-document's collection.
Occurs when the current multi-document's collection is about to be cleared.
Occurs when the current multi-document's collection has been cleared.
Occurs when a has been loaded, parameters (if any) have been prepared,
but the report or document represented by the item has not been generated yet.
Allows to adjust the properties of the report or document prior to generation
(e.g. the data source of a C1Report may be assigned here).
Specifies how outlines of a document or report associated with a multi-document item
are treated when the outline tree for the whole multi-document is prepared.
The outlines of the associated document or report are added as children of
the multi-document item's outline node.
The outlines of the associated document or report replace
the multi-document item's outline node.
Represents an item (individual document or report) in a .
Initializes a new instance of the type.
The item descturctor.
Disposes the current multi-document item.
Sets the document represented by the current item.
The document that is to be represented by this item.
Gets the document represented by the current multi-document item.
The document represented by this item.
Gets the collection of outlines defined on the document or report
represented by the current multi-document item.
For details, see the remarks section of the property.
Gets the value of the EmfType property of the document or report
represented by the current multi-document item.
This property is null if no document or report is associated
with the current item.
Gets the value of the UseGdiPlusTextRendering property of the document or report
represented by the current multi-document item.
This property is null if no document or report is associated
with the current item.
Gets the value of the ColorizeHyperlinks property of the
represented by the current multi-document item.
This property is null the current item does not represent a C1Report.
Gets or sets the outline node representing the current item in .
For details, see the remarks section of the property.
The combined outline for the multi-document.
Gets or sets a value specifying how outlines of the document or report
represented by the current item will be treated when the outline for the
whole multi-document is prepared.
This property is ignored if is null.
For details, see the remarks section of the property.
Gets collection containing this object.
Gets the collection containing the current object.
Gets the index of the current item in the containing collection.
Gets the 0-based index of the first page of the document associated
with the current item within the containing .
Gets the 0-based index of the last page of the document associated
with the current item within the containing .
The value is undetermined if the associated document has not been generated.
Gets the total number of pages in the document associated
with the current item.
The value is -1 if the associated document has not been generated.
Gets the name of the disk file used to store the document associated with the current item.
If the item is stored in memory, this value is null.
Gets the list of file names used to store the document or report represented by the current item.
If this item is stored in memory, this value is null.
Gets a value indicating whether the current item is empty.
Represents a collection of objects.
Gets the type of collection elements.
The type.
Clears the current collection, disposing all contained objects.
Searches the items in this collection for a
with the specified value of the property.
The outline node to search for.
The requested item or null.
Creates a , associates it with the specified document,
and adds it to the current collection.
Note that the passed document reference is not stored in the created item,
see for details.
The document that is associated with the new item.
The newly created item.
Creates a , associates it with the specified report,
and adds it to the current collection.
Note that the passed document reference is not stored in the created item,
see for details.
The report that is associated with the new item.
The newly created item.
Creates a , associates it with the specified report,
and adds it to the current collection.
Note that the passed document reference is not stored in the created item,
see for details.
The report that is associated with the new item.
The newly created item.
Adds the specified item to the current collection.
The item that is added.
The index of the added item within the collection.
Creates a , associates it with the specified document,
and inserts it into the current collection at the specified index.
Note that the passed document reference is not stored in the created item,
see for details.
The zero-based index at which the new item should be inserted.
The document that is associated with the new item.
The newly created item.
Inserts an item into the current collection at the specified index.
The zero-based index at which the item should be inserted.
The item to insert.
Removes an item from the current collection.
The item to remove.
Gets containing this object.
Gets or sets the at the specified index.
Indicates whether leaf-level values (for example, text box values and chart data values)
should render as elements or attributes.
Data element style is determined automatically.
Render values as attributes.
Render values as elements.
For internal use.
The abstract base class for reports implementing various flavors of
RDL (Report Definition Language) specification.
Initializes a new instance of C1RdlReportBase.
Destructs the current instance of C1RdlReportBase.
Releases the resoureces used by .
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Clears all temporary data created during report generation.
Tests whether a specified RDL format version is supported by the current component.
The RDL format version to test.
true if the specified format version is supported, false otherwise.
Clears the pages and other info produced by the document generation.
Copies properties from another to the current object.
The source object to copy properties from.
Clears the current report, sets all properties to their default values.
Loads a report definition from a stream into the current report.
The stream should contain an RDL report definition in the supported format.
The stream containing the report definition.
Loads a report definition from a file into the current report.
The file should contain an RDL report definition in the supported format.
The file containing the report definition.
Saves the currently loaded report definition to a stream.
The target stream.
Saves the currently loaded report definition to a disk file.
The target file name.
Renders the report.
This method is called implicitly when the property is accessed,
so you rarely have to call it directly from your code.
Creates a new instance of a type derived from
that supports the RDL format contained in the specified stream.
The specific type is determined by the version of the RDL in the stream.
The stream from which to load the report.
The report component that was created.
Creates a new instance of a type derived from
that supports the RDL format contained in the specified file.
The specific type is determined by the version of the RDL in the file.
The file name from which to load the report.
The report component that was created.
Gets the name of the document (used to identify reports in print tasks and so on).
Gets or sets the RDL format version of the currently loaded report definition.
Changing the value of this property after a report has been loaded
allows to save it in the newly specified format version.
Gets a object representing the report.
Note that if the report is empty, it is rendered before this property returns.
Gets a value indicating whether the current report has not been generated
(i.e. has no generated pages).
Note that this property does not depend on whether a report definition has been
loaded into the current report.
Gets the collection of warnings produced when the current report was generated.
If this is a subreport then the master report's collection of warnings is returned.
Gets the date/time when the report began generating.
If this is a subreport then the master report's ExecutionTime is returned.
Gets the file name from which the current report definition has been loaded,
or where it has been last saved.
If the current report is generating (see ),
gets the approximate completion ratio, from 0 (0% complete) to 1 (100% complete).
If the report is currently not generating, gets 1.
Gets a value that determines whether a report is currently being generated.
Gets or sets arbitrary data associated with the current report.
Gets or sets an Xml string containing the complete report definition.
This property can be used to store report definitions into databases, to place them in the clipboard,
or to copy reports from one RDL report component to another.
Occurs periodically during report generation.
Allows to provide progress indication and the ability to cancel generation to the user.
Represents information about a drillthrough action.
For internal use.
For internal use.
For internal use.
For internal use.
Initializes a new instance of the class.
Copies properties from another object to the current object.
The source object to copy properties from.
Gets or sets the full folder path (for example, “/salesreports/orderdetails”),
relative path (for example, “../orderdetails”) or URL
(for example, “http://reportserver/reports/sales/orderdetails”) of the
drillthrough report.
Relative paths start in the same folder as the report.
Note: If the current report is being used as a subreport,
the top-level report location is used as the base of the relative path.
Gets the collection containing
parameters to the drillthrough report.
Defines a hyperlink, bookmark link or drillthrough action associated with
a report element.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the collection containing the current object.
Gets or sets an that evaluates to the URL of the hyperlink.
Gets a object containing info about the drillthrough report
that should be executed when the current hyperlink is clicked.
Gets or sets an that evaluates to the ID of a bookmark in the
report to go to when this report item is clicked on.
(If no bookmark with this ID is found, the link will not be included in
the report. If the bookmark is hidden, the link will go to the start of
the page the bookmark is on. If multiple bookmarks with this ID are found,
the link will go to the first bookmark.)
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
Defines a list of actions associated with a .
Copies properties from another to the current object.
The source object to copy properties from.
Gets the collection represented by the current object.
Represents the visual elements of the body of the report.
Abstract base class for the report elements such as
, , .
Should be implemented by a class that owns a object.
Gets the default border color.
Gets the default color.
Gets the default background color.
Gets the default gradient end color.
Initializes a new instance of the class.
For internal use.
For internal use.
Copies properties from another to the current object.
The source object to copy properties from.
Clears the current object, sets all properties to their default values.
Gets the object defining style information for the current .
Initializes a new instance of the class.
object containing this object.
For internal use.
Copies properties from another to the current object.
The source object to copy properties from.
Clears the current object, sets all properties to their default values.
Gets the object containing this object.
Gets the collection containing elements of the current report body.
Gets or sets the height of the current report body.
Indicates whether leaf-level values (for example, text box values and chart data values)
should render as elements or attributes.
Data element style is determined automatically.
Render values as attributes.
Render values as elements.
Represents an RDL (Report Definition Language) report defined using the
2008 version of the RDL specification.
Initializes a new instance of the class.
Overridden. Clears all temporary data created during report generation.
Copies properties from another to the current object.
The source object to copy properties from.
Clears the current report, sets all properties to their default values.
Scans the current report definition and retrieves the list of report names
() of items
contained within the current report.
The list of report names, or an empty list if there are no subreports.
Overridden. Returns the current report's
(used to identify reports in print tasks and so on).
Gets or sets a value indicating whether a dialog allowing to input values for some or all
of the report parameters (elements of the collection) should be shown
to the user before the report generates. To include or exclude parameters from the dialog,
use .
The default value is true.
Gets or sets a value indicating whether all text in the current report
should be rendered using GDI+ text API.
The default value is false.
Gets or sets the type of metafiles created by the current report.
The default is .
Gets or sets the description of the report.
Gets or sets the author of the report.
Gets or sets the rate, in seconds, at which the report page
(when rendered as HTML) automatically refreshes. Must be nonnegative.
If omitted or zero, the report page should not automatically refresh.
Max: 2147483647.
Default: 0.
Gets the data sources from which data sets are taken for this report.
Gets or the data that is displayed as part of the report.
Gets the object describing how the body of the
report is structured and rendered.
Gets the collection containing
parameters of the report.
Gets the object containing
custom information to be handed to the report rendering component
Gets or sets the string containing
definitions for custom functions to be used in expressions in the report.
Custom functions must be instance methods.
If a function OnInit() is defined within code, it is called during parameter,
report and page header/footer initialization.
The function must be defined as Protected and Overrides.
Gets or sets the width of the report.
Gets the object
containing page layout information about the report.
Gets the collection containing
images embedded in the report.
Gets or sets the primary language of the text.
Used as the default for all language-dependent expressions in the report.
Gets the collection containing
code modules to make available to the report for use in expressions.
Gets the collection containing
info about classes to instantiate during report initialization.
Gets the collection containing
variables defined for the report as a whole.
Gets or sets a value indicating that variables throughout the report
are not required to be pre-evaluated at the start of report processing and
may be evaluated on-demand based on usage.
Deferred variable evaluation can improve performance but should not be used
if any variables are time-dependent.
Gets or sets a value indicating that all whitespace in containers
(such as and ) should be consumed when
contents grow rather than preserving the minimum whitespace between the contents
and the container.
Gets or sets the location to a transformation to apply to a report data rendering.
This can be a full folder path (for example, “/xsl/xfrm.xsl”) or relative
path (for example “xfrm.xsl”).
Relative paths start in the same folder as the report.
Gets or sets the schema or namespace to use for the report data rendering.
Gets or sets the name of a top level element that represents the report data.
Default: Report. Must be a CLS-compliant identifier.
Gets or sets a value indicating whether leaf-level values
(for example, text box values and chart data values)
should render as elements or attributes.
Gets a value indicating whether the current report contains any items.
Contains information about a class to instantiate during report initialization.
This class instance can be used in expressions throughout the report.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the name of the class.
Gets or sets the name of the member variable of Class to assign the class to.
This member variable can be used in expressions throughout the report.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
Represents a hyperlink, a bookmark link or a drillthrough action associated with
a report element.
Initializes a new instance of the class.
Initializes a new instance of the class.
Value of property.
Copies properties from another to the current object.
The source object to copy properties from.
Gets collection containing the current object.
Gets or sets the name of the current .
Converts to/from other types.
Converts a string to a .
An that provides a format context.
The string to convert.
A representing .
Converts an object to a string.
An that provides a format context.
The object to convert.
The converted string.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
The , and
allows to pass information to custom report renderers and custom report items.
Initializes a new instance of the class.
Value of property.
Value of property.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets name of the property.
Gets or sets value of the property.
Represents the collection of objects.
Adds the specified to the current collection.
The object to add.
The index of the newly added object in the current collection.
Creates and adds object to the current collection.
Value of property.
Value of property.
The index of the newly added object in the current collection.
Searches for object with specified name.
Search is not case sensitive.
Name of the .
object or null.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the at the specified index.
Gets or sets value of with specified name
if object is not found returns null.
The , and
allows to pass information to custom report renderers and custom report items.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Clears collection and resets all properties
to default values.
Gets the collection.
Abstract base class for data aggregate functions.
Tests whether an object represents a null value.
The object to check.
true if represents a null value, false otherwise.
Tests whether an object represents a number.
The object to check.
true if represents a number, false otherwise.
Converts an object to a double number.
The object to convert.
The converted double value.
This method is called when aggregate calculation starts.
Should be overridden in derived classes.
This method is called for each value in the data scope.
Should be overridden in derived classes.
A value to aggregate.
This method is called when iteration over data scope is finished.
Should be overridden in derived classes.
The value of the aggregate function.
This method is called when the list of aggregates values is empty.
The value of the aggregate function when the list of aggregates values is empty.
Represents the summary (SUM) aggregate function.
Resets the current aggregate.
Aggregates a value.
A value to aggregate.
Returns the aggregated value.
The aggregated value
Represents the average (AVG) aggregate function.
Resets the current aggregate.
Aggregates a value.
A value to aggregate.
Returns the aggregated value.
The aggregated value
Represents the maximum (MAX) aggregate function.
Resets the current aggregate.
Aggregates a value.
A value to aggregate.
Returns the aggregated value.
The aggregated value
Represents the minimum (MIN) aggregate function.
Resets the current aggregate.
Aggregates a value.
A value to aggregate.
Returns the aggregated value.
The aggregated value
Represents the count (COUNT) aggregate function.
Resets the current aggregate.
Aggregates a value.
A value to aggregate.
Returns the aggregated value.
The aggregated value
Gets the aggregate value corresponding to an empty list.
Zero (0).
Represents the "count distinct" aggregate function.
Resets the current aggregate.
Aggregates a value.
A value to aggregate.
Returns the aggregated value.
The aggregated value
Gets the aggregate value corresponding to an empty list.
Zero (0).
The abstract base class for standard deviation and variance aggregates.
Resets the current aggregate.
Aggregates a value.
A value to aggregate.
Returns the aggregated value.
The aggregated value
Called by to calculate the aggregate value.
The average value.
The sum of squared values.
The values count.
The aggregated value.
Represents the standard deviation (STDEV) aggregate function.
Calculates the aggregated value.
The average value.
The sum of squared values.
The values count.
The aggregated value.
Represents the standard deviation based on the entire population (STDEVP) aggregate function.
Calculates the aggregated value.
The average value.
The sum of squared values.
The values count.
The aggregated value.
Represents the variance (VAR) aggregate function.
Calculates the aggregated value.
The average value.
The sum of squared values.
The values count.
The aggregated value.
Represents the variance based on the entire population (VARP) aggregate function.
Calculates the aggregated value.
The average value.
The sum of squared values.
The values count.
The aggregated value.
Contains information about a parameter that is passed to the data source
as part of the query.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets a value of can be specified as expression.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
Defines types of .
The of a
contains the SQL query text.
The of a
contains the name
of a stored procedure that should be executed to retrieve the data.
The of a
contains the name
of a data table.
Contains the description of the query to execute to retrieve the data for the report.
Copies properties from another to the current object.
The source object to copy properties from.
Gets a object containing this object.
Gets or sets name of to execute the query against.
Gets or sets the value indicating what type of query is contained in the .
Gets or sets the query to execute to obtain the data for the report.
Can be specified as expression.
Gets the collection containing a list of parameters
that are passed to the data source as part of the query.
Gets or sets the number of seconds to allow for the query to run before timing out.
Must be nonnegative. If zero (default), the query should not time out. Max: 2147483647.
Contains information about a field in the data model of the report.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the name of the field in the query.
Note: Data field names do not have to be unique. Multiple fields can refer to the same data field name.
Field must have exactly one of the following: or .
Gets or sets the expression that evaluates to the value of this field.
For example: =Fields!Price.Value+Fields!Tax.Value.
The expression cannot contain aggregates or references to report items.
Field must have exactly one of the following: or .
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
Describes a filter to apply to rows of data in a data set or data
region or to apply to group instances.
Initializes a new instance of the class.
Copies properties from another to the current object.
and are copied by reference.
The source object to copy properties from.
Gets collection containing this object.
Gets or sets an expression that is evaluated for each instance within
the group or each row of the data set or data region and compared
(via the ) to the .
Failed comparisons result in the row/instance being filtered out of
the data set, data region or group.
Gets or sets the operator used to compare
the and .
Gets the values to compare to the .
For Equal, Like, NotEqual, GreaterThan, GreaterThanOrEqual, LessThan,
LessThanOrEqual, TopN, BottomN, TopPercent and BottomPercent,
there must be exactly one FilterValue.
For TopN and BottomN, the FilterValue expression must evaluate
to an integer.
For TopPercent and BottomPercent, the FilterValue expression must evaluate
to an integer or float.
For Between, there must be exactly two FilterValue elements.
For In, the are treated as a set
(if the value appears anywhere in the set
of , the instance is not filtered out.)
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
Contains information about a set of data to display as a part of the report.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets object containing this object.
Gets collection owning this object.
Gets the collection containing fields of the data set.
Gets the object containing
information about the data source, including connection information,
query, and so on, required to get the data from the data source.
Gets or sets a value indicating whether the data is case sensitive.
- AutoDefault. The case sensitivity setting should be autoderived by querying the data provider.
Defaults to False if the data provider does not support that method.
- TrueData in this data set is case sensitive.
- FalseData in this data set is case insensitive.
Gets or sets the locale to use for the collation sequence for sorting data.
Uses the standard Microsoft SQL Server collation names.
If no Collation is specified, the collation setting should be autoderived
by querying the data provider. Defaults to the collation corresponding to
the report’s property if the data provider does not support
that method or returns an unsupported or invalid value.
Gets or sets a value indicating whether the data is accent sensitive.
- AutoDefault. The accent sensitivity setting should be autoderived by querying the data provider.
Defaults to False if the data provider does not support that method.
- TrueData in this data set is accent sensitive.
- FalseData in this data set is accent insensitive.
Gets or sets a value indicating whether the data is kanatype sensitive.
- Auto
Default. The kanatype sensitivity setting should be autoderived by querying the data provider. Defaults to False if the data provider does not support that method.- TrueData in this data set is kanatype sensitive.
- FalseData in this data set is kanatype insensitive.
Gets or sets a value indicating whether the data is width sensitive.
- AutoDefault. The width sensitivity setting should be autoderived by querying the data provider.
Defaults to False if the data provider does not support that method.
- TrueData in this data set is width sensitive.
- FalseData in this data set is width insensitive.
Gets the collection containing filters to apply to
each row of data in the data set.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Returns with specified name.
The name of the item to locate.
The specified item
Gets object owning this object.
Gets or sets the at the specified index.
Contains information describing how to connect to a data source.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the string defining the type of the data source
(for example “SQL”, “OLEDB”, “OLEDB-MD”).
This is the name of a registered data provider.
Gets or sets the connection string for the data source.
Can be specified as an expression.
Gets or sets a value indicating whether this data source should be
connected to using integrated security.
Gets or sets the prompt displayed to the user when prompting for database
credentials for this data source.
Represents a data source.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the object containing the current object.
Gets the collection containing the current object.
Gets or sets a value indicating whether the data sets that use this
data source should be executed in a single transaction.
The default is false.
Gets the object containing information
about how to connect to the current data source.
A must have one and only one of the following properties
specified: or .
Gets or sets the full folder path (for example, “/salesreports/salesdatabase”)
or relative path (for example, “salesdatabase”)
to a data source on the same server.
Relative paths start in the same folder as the report.
The data source uses the connection properties from the DataSourceReference.
If report rendered locally then this property should contain path
to the RDS file describing datasource.
A must have one and only one of the following properties
specified: or .
TBD:
Gets or sets the data source object that provides data to this object.
Following objects can be assigned to this property:
- Object supporting interface
- Object supporting or interface
If assigned object does not contain list of fields (like DataTable or DataView)
then fields are built via interface. If
interface is not supported then fields is a public properties of the first
object in the collection.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Finds a with the specified name.
The name of the item to locate.
The specified item
Gets object containing the current collection.
Gets or sets the at the specified index.
Represents an image embedded in the report.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the MIMEType for the image.
Valid values are as follows: image/bmp, image/jpeg, image/gif, image/png, image/x-png.
Gets or sets base-64 encoded image data.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
defines the expressions to group the data by.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets name of the Group.
No two group elements may have the same name.
No group element may have the same name as a data set or a data region.
Gets or sets a label to identify an instance of the group in
the client UI (to provide a user-friendly label for searching).
Gets the expressions by which to group the data.
If empty, this is a detail group
(that is, there is one instance of the group per detail row of data).
Gets object defining page break behavior for this group.
Gets collection containing
filters to apply to each instance of the group.
Gets or sets an expression that identifies the parent group in a recursive hierarchy.
Only allowed if the group has exactly one group expression.
Indicates the following:
1. Groups should be sorted according to the recursive hierarchy
(Sort is still used to sort peer groups).
2. Labels (in the document map) should be placed/indented
according to the recursive hierarchy.
3. Intra-group show/hide should toggle items according to
the recursive hierarchy (see ToggleItem).
If filters on the group eliminate a group instance’s parent,
it is instead treated as a child of the parent’s parent.
In the event of a loop, one of the parent-child relationships will be ignored.
Gets or sets the name to use for the data element for instances of this group.
Default (if not specified): Name of the group.
Must be a CLS-compliant identifier.
Gets or sets value indicating
whether the instances of the group should appear in a data rendering.
Gets collection
containing a set of variables to evaluate at the group level.
Defines the layout of report items to appear at the top or bottom of every page
of the report.
The element itself is not used.
Only subtypes of are used: , .
Initializes a new instance of the class.
object containing this object.
Copies properties from another to the current object.
The source object to copy properties from.
Clears the current object, sets all properties to their default values.
Gets the object containing this object.
Gets object containing this object.
Gets or sets the height of the page section.
Gets or sets the value indicating if the page section should be shown
on the first page of the report.
Not used in single-page reports if this is a PageFooter.
Gets or sets the value indicating if the page section should be shown
on the last page of the report.
Not used in single-page reports if this is a PageHeader.
Gets the collection containing
the elements of the page section layout.
No data regions or subreports are allowed in the page section.
All page breaks are ignored in the page section.
Defines the layout of report items to appear at the top of every page
of the report.
Initializes a new instance of the class.
object containing this object.
Defines the layout of report items to appear at the bottom of every page
of the report.
Initializes a new instance of the class.
object containing this object.
Contains page layout information for the .
Initializes a new instance of the class.
object containing this object.
Copies properties from another to the current object.
The source object to copy properties from.
Clears the current object, sets all properties to their default values.
Gets the object containing this object.
Gets the object that is rendered at the top of
each page of the report.
Gets the object that is rendered at the bottom of
each page of the report.
Gets or sets the default height for rendering the report in a physical-page
oriented renderer. Default: 11 in. Must be greater than 0 in.
Gets or sets the default width for rendering the report in a physical-page
oriented renderer. Default: 8.5 in. Must be greater than 0 in.
Gets or sets the default height for rendering the report when in an
interactive renderer.
There is no maximum size. A value of 0 (with any unit) indicates height should be unlimited.
Defaults to .
Gets or sets the default width for rendering the report when in an
interactive renderer.
There is no maximum size. A value of 0 (with any unit) indicates width should be unlimited.
Defaults to .
Gets or sets the width of the left margin. Default: 0 in.
Gets or sets the width of the left margin. Default: 0 in.
Gets or sets the width of the left margin. Default: 0 in.
Gets or sets the width of the left margin. Default: 0 in.
Gets or sets the default number of columns for rendering the report.
Default: 1. Min: 1. Max: 1000
Gets or sets the spacing between each column in multi-column renderings.
Default: 0.5 in.
Defines positions to page break.
Page break should be before the or each instance of the .
Page break should be after the or each instance of the .
Page break should be before and after the or each instance of the .
Page break should be between each instance of the .
Defines page break behavior for a or .
Initializes a new instance of the class.
Value of BreakLocation property.
Gets or sets value indicating where the page break should occur.
Contains information about a parameter to a subreport or drillthrough.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets value or expression that evaluates to the value to hand in for
the parameter to the subreport or control.
For in , this is the name of a
DataField from which to obtain the value rather than an expression.
Gets or sets value indicating the parameter should be skipped.
Valid only for parameters.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
For internal use.
For internal use.
Represents a fragment of a in a resolved .
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
For internal use.
For internal use.
Called when the resolved sizes of the object should be changed,
for example when resolving of table is finished and
height of all objects in a row is set to the same value.
Object may ignore this changing and not change self size.
This method is called only for child objects, so and are
relative to the top left corner of the parent.
New left coordinate of the fragment.
New top coordinate of the fragment.
New width of the fragment.
New height of the fragment.
Gets a value indicating whether a full re-resolving of the whole render object is needed.
The area on the page.
The X coordinate on the page.
The Y coordinate on the page.
The width of the fragment.
The height of the fragment.
true if the containing this fragment should be re-resolved.
Calculates a value of dimension specified by LengthAbs.
Dimension to calculate.
LengthAbs object defining a value of dimension.
The custom object's dimension is resolved.
Contains PageAreaBase object referenced by LengthAbs on exit.
Contains value of coordinate or size on exit.
Gets the object referenced by a object.
Called only from .
The dimension which is specified by .
The to check.
The object referenced by .
Calculates a value of dimension specified by the LengthRef object.
(dimension references a dimension of another object).
Dimension to calculate.
LengthRef object defining a value of dimension.
Indicates that the custom object dimension is resolved, coordinate of point for RenderLine, width of column for RenderTable etc.
Contains PageAreaBase object referenced by LengthRef on exit.
Contains value of coordinate or size on exit.
Calculates a value of dimension specified by the LengthExp object.
(dimension is an expression).
Dimension to calculate.
LengthExp object defining a value of dimension.
Indicates that the custom object dimension is resolved, coordinate of point for RenderLine, width of column for RenderTable etc.
Contains PageAreaBase object on exit.
Contains value of coordinate or size on exit.
true if no error occurs, false otherwise.
Resolves an absolute dimension of object.
Dimension to resolve.
LengthAbs object defining a value of dimension.
Resolves an auto dimension of object.
Dimension to resolve.
LengthAuto object defining a value of dimension.
Resolves a dimension of object specified as reference.
Dimension to resolve.
LengthRef object defining a value of dimension.
Resolves a expression dimension of object.
Dimension to resolve.
LengthExp object defining a value of dimension.
Returns true if no error occurs.
For internal use.
Calculates a value of dimension.
Only LengthRef, LengthAbs, LengthExp can be specified as length.
Dimension to calculate.
Value of dimension, can be LengthAbs, LengthRef or LengthExp.
Indicates that the custom object dimension is resolved, coordinate of point for RenderLine, width of column for RenderTable etc.
Contains PageAreaBase object on exit or nul if coordinate is relative.
Contains value of coordinate or size on exit.
This method can be called only by *another* RenderFragment object
during resolving LengthRef object.
Dimension which must be resolved.
Override this method to perform additional initializations of resolved info
of object on reresolving.
Some dimensions of object do not change when it splits, so you
can use this method to copy some information from
old resolved info to new resolved info.
Override this method to calculate the width of object on basis of its content,
this method is called when width of object specified as auto, for example:
obj.Width = Unit.Auto;
Height of area of contents of object.
Width of area of contents of object, value must be specified in the "Document.ResolvedUnit" units.
Override this method to calculate the height of object on basis of its content,
this method is called when height of object specified as auto, for example:
obj.Height = Unit.Auto;
Width of area of contents of object.
Height of area of contents of object, value must be specified in the "Document.ResolvedUnit" units.
Returns true if no error occurs.
Override this method to calculate sizes of object on basis of its content,
this method is called when width and height of object specified as auto.
Width of area of contents of object, value must be specified in the "Document.ResolvedUnit" units.
Height of area of contents of object, value must be specified in the "Document.ResolvedUnit" units.
Returns true if no error occurs.
For internal use.
Override this method to define the drawing flags.
These flags manage the object's painting.
For internal use.
For internal use.
Draws background of object.
Graphics object on which the object is being drawn.
Bounds of inner area of object.
Retures GraphicsPath object representing the rounded object's border,
if border is not rounded returns nil.
The graphics to use.
Outer rectangle of borders.
Sizes of borders.
Whether to use GDI drawing.
OUT: clip path.
OUT: clip region.
Draws borders of object.
Graphics object on which the object is being drawn.
Outer rectangle of borders.
Sizes of borders.
Override this procedure if GetDrawingFlags does not set the DrawingFlagsEnum.UseGdiDrawing flag.
Graphics object on which the object is being drawn.
Contains data needed for drawing.
Override this procedure if GetDrawingFlags sets the DrawingFlagsEnum.UseGdiDrawing flag.
DC on which the object is being drawn.
Contains data needed for drawing.
For internal use.
For internal use.
For internal use.
Override this method and return the horizontal splits in the object relative to the left edge of
the content area.
Override this method and return the vertical splits in the object relative to the top top edge of
the content area.
Creates a SplitParams object, used during splitting, child
classes may override this method to create the SplitParams object of custom type
(derived from SplitParams).
For internal use.
Checks can object's content be split on specified position by vertically.
SplitParams object defining the parameters of splitting.
Returns true if object can be split on specified position (p.ContentRealSplitPos).
Splits content of object by vertically, by default this procedure split object as image.
The created fragment describing part of object before contentSplitPos.
SplitParams object defining the paramters of splitting.
Checks can object's content be split on specified position by horizontally.
SplitParams object defining the parameters of splitting.
Returns true if object can be split on specified position.
Splits content of object by horizontally, by default this procedure split object as image.
The created fragment describing part of object before contentSplitPos.
SplitParams object defining the paramters of splitting.
For internal use.
Performs splitting of RenderFragment object.
New fragment which was created as result of splitting.
SplitParams object describing the splitting.
Returns true if shadow visible for .
true if shadow visible for and false otherwise.
Creates a copy of the current .
The newly created object.
Assigns (copies) properties from another to the current object.
Clones by cloning all its elements.
The source object to copy properties from.
This method is called by the rendering engine after the current
has been completely resolved.
Typically this method would be used to clear temporary data created and used during resolving.
For internal use only.
Draws the current fragment on a specified .
The object to draw on.
The draw bounds.
The paretnt bounds.
true to draw input controls (see ), false to ignore them.
true to draw child fragments, false to ignore them.
Indicates whether to write metafile comments to graphics: info about anchors, hyperlinks etc.
Draws the current fragment and its children on a specified .
The object to draw on.
The paretnt bounds.
true to draw input controls (see ), false to ignore them.
Draws the current fragment and its children on a specified .
The object to draw on.
The paretnt bounds.
true to draw input controls (see ), false to ignore them.
true to write metafile comments containing anchors, hyperlinks etc.
Draws the current fragment and its children on a specified .
The object to draw on.
true to draw input controls (see ), false to ignore them.
Calculates the location of a
contained in the collection of the
render object that produced the current fragment.
The object to get the location of.
OUT: The bounds of in the fragment in units.
(Note that this parameter is assigned a valid value only if is true on method return.
OUT: true if appears in the current fragment, false otherwise.
Searches for a object in the current fragment at the specified position.
Specifies a point within the current fragment relative to the top left corner of the fragment.
A object describing the found , or null if none was found.
Adds information about all hyperlinks that appear in the current fragment
to a .
The collection of objects
to which data about hyperlinks within the current fragment will be added.
Checks whether any of the child fragments of the current fragment
are clipped by its bounds. Depending on the
parameter, may also recursively test all child fragments.
If true, this method is called recursively
on all child fragments. If false, only the immediate children of the
current fragment are tested.
true if any of the children is clipped by the fragment's bounds,
false otherwise.
Gets the most nested containing the current fragment,
or null if the current object is not contained in a table.
Gets the 0-based index of the row in the most nested
containing the current render object (i.e. the row index on the current page),
or -1 if the current object is not contained in a table.
Gets the 0-based index of the column in the most nested
containing the current render object (i.e. the column index on the current page),
or -1 if the current object is not contained in a table.
Gets the page containing the current fragment.
Gets the 0-based index of containing the current fragment.
Gets the 0-based index of the column on the page containing the current fragment.
For the default single-column page layout, the value of this property is 0.
If the current fragment belongs to a page header or footer, this value is -1
(see and ).
Gets a value indicating whether the current fragment belongs to the page header.
Gets a value indicating whether the current fragment belongs to the page footer.
Gets or sets the current fragment's bounds within its parent.
For top level fragments, bounds within are returned.
Gets the inner bounds of the current fragment
(without spacing, borders and padding)
within its parent.
Gets the bounds of the current fragment on the page.
Gets the inner bounds of the current fragment
(without spacing, borders and padding)
on the page.
Gets the object containing the current fragment.
Gets the that produced the current fragment.
Gets that is the parent of the current fragment.
Gets the top level containing the current fragment.
Gets a value indicating whether the current fragment is visible.
Gets the 0-based index of the current fragment in the
collection of the that produced it.
Gets the 0-based index of the current fragment in the
collection of its .
Gets the nesting level of the current fragment in the fragments' tree.
The topmost fragment (that has no parent) has level 1.
Gets a value indicating whether the collection
of the current fragment has been initialized and contains one or more elements.
Gets a containing the child
fragments of the current fragment.
This property always returns a non-null fragments collection,
initializing it if it has not been initialized yet.
Use to test whether there are any children
without initializing .
Gets the value indicating whether the parent object is clipped.
(Returns the value of for top-level fragments,
of the parent fragment's render object for nested ones.)
For internal use.
For internal use.
For internal use.
For internal use.
Specifies the output type for a data element.
Will behave as for any report item with Hidden set to True
(not an expression) that does not have a ToggleItem, and for any
report item in a static tablix member that cannot be toggled with
Hidden set to non-expression True. Otherwise, acts
as NoOutput for Textboxes with constant TextRun values,
as ContentsOnly for Rectangles and as Output for all other items.
Indicates the item should appear in the output.
Indicates the item should not appear in the output.
Indicates the item should not appear in the XML, but its contents
should be rendered as if they were in this item’s container.
Only applies to Rectangles.
Abstract base class for report objects such as , etc.
Initializes a new instance of the class.
For internal use.
For internal use.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the containing the current object.
Gets or sets the name of the current report item.
That name should not be empty and must be unique within the report.
Gets the object containing actions
(such as hyperlinks) associated with the current object.
Gets or sets the distance of the current item from the top of the containing object.
The default is 0.
Gets or sets the distance of the current item from the left of the containing object.
The default is 0.
Gets or sets the height of the current item.
Negative sizes are allowed only for lines (the height/width gives the offset of the endpoint of the line from the start point).
Default is null which means the width of the containing object minus .
Gets or sets the width of the current item.
Negative sizes are allowed only for lines (the height/width gives the offset of the endpoint of the line from the start point).
Default is null which means the height of the containing object minus .
Gets the right coordinate of the current object.
Gets the bottom coordinate of the current object.
Gets or sets the drawing order of the current report item within containing object.
Items with lower indices are drawn first (appearing behind items with higher indices).
Items with equal indices have unspecified rendering order.
Default: 0 Min: 0 Max: 2147483647
Gets the object indicating if the current item should be hidden.
Gets or sets a textual label for the current report item.
Gets or sets a label to identify an instance of the current report item
within the client UI (to provide a user-friendly label for searching).
Hierarchical listing of report item and group labels within the UI
(the Document Map) should reflect the object containment hierarchy in
the report definition.
Peer items should be listed in left-to-right top-to-bottom order.
If the expression returns null, no item is added to the Document Map.
Not used for report items in the page header or footer.
Gets or sets a bookmark that can be linked to via a action.
Gets or sets the name of a data region that this report item should be
repeated with if that data region spans multiple pages.
The data region must be in the same ReportItems collection as this
ReportItem (Since data regions are not allowed in page headers/footers,
this means RepeatWith will be unusable in page headers/footers).
Not allowed if this report item is a data region, subreport or rectangle
that contains a data region or subreport.
Gets collection containing custom information
about the current report item.
Gets or sets the name to use for the data element/attribute for this report item.
Default: Name of the report item. Must be a CLS-compliant identifier.
Gets or sets a value indicating whether the current item should appear in a data rendering.
Represents a collection of objects.
Initializes a new instance of the class.
Called when the collection is about to be cleared.
Called after an item has been removed.
The item index.
The item.
Called when an item is about to be set.
The item index.
The old item.
The new item.
Called when an item is about to be iserted.
The item index.
The item.
Returns typeof().
typeof().
Adds the specified to the current collection.
The object to add.
The index of the newly added object in the current collection.
Removes the specified from the current collection.
The object to remove.
Inserts the specified into the current collection.
The index where to insert the object.
The object to insert.
Gets containing this collection.
Gets or sets the at the specified index.
Represents a simple list of objects.
Searches the current collection for an object with the specified .
The name to search for.
Index of the object in the current collection, or -1 if no object was found.
Gets the index of a in the current collection.
The item to search for.
The index of .
Gets the at the specified index.
Specifies possible positions of the title along the axis.
Position the title on the center of the axis.
Position the title on the near side of the axis.
Position the title on the far side of the axis.
Represents a title for the axis.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the caption of the title.
Gets or sets the position of the title along the axis.
Default: Center.
Gets or sets the text orientation.
Default: Auto.
Gets the object defining style properties for the title.
Specifies the types of line used to show the scale break.
Display as a ragged line.
Display as a straight line.
Display as a wavy line.
Do not display a line for the scale break.
Represents the scale break behavior and style for an axis.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets a value indicating whether scale breaks can be automatically applied.
Default: False.
Gets or sets the type of line used to show the scale break.
Gets or sets the percentage of empty space allowed on the axis before a scale break is triggered.
Must be greater than 0. Default: 25.
Gets or sets the maximum number of scale breaks to apply.
Default: 2.
Gets or sets the amount of space to leave for a scale break,
as a percentage of the chart size.
Default: 1.5.
Gets or sets a value indicating whether to prevent a scale break from spanning zero.
Default: Auto.
Gets the object defining style properties for the scale break.
Specifies units used by .
The default interval is used.
Interval unit is autoderived based on the data plotted against the axis.
Interval is numeric.
Interval is Years.
Interval is Months.
Interval is Weeks.
Interval is Days.
Interval is Hours.
Interval is Minutes.
Interval is Seconds.
Interval is Milliseconds.
Represents gridlines along an axis.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets a value indicating whether the grid lines should be shown.
Default is Auto, which means true for major grid lines and false for minor grid lines.
Gets or sets the interval between gridlines.
Default (0) uses .
Gets or sets units for the .
Default: ,
in which case is used.
Gets or sets the offset for the first grid line from the axis min.
Default (0) uses .
Gets or sets the units for the .
Default: ,
in which case is used.
Gets the object defining the style of the grid lines.
Specifies the types of tick marks.
Tick mark outside the axis.
Tick mark inside the axis.
Tick mark across the axis.
No tick mark.
Represents tick marks along an axis.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets a value indicating whether tick marks should be shown.
Default: Auto, which means true for major tick marks and false for minor tick marks.
Gets or sets the type of the tick mark.
Gets the object defining the line style for tick marks.
Gets or sets the length of the tick mark as a percentage of the chart size.
Default: 1.
Gets or sets the interval between tick marks.
Default (0) uses .
Gets or sets the units for the .
Default: ,
which in this case means .
Gets or sets the offset for the first tick mark from the axis min.
Default (0) uses .
Gets or sets the units for the .
Default: ,
which in this case means .
Specifies the side where axis should be drawn.
Draw the axis on the default side.
Draw the axis on the opposite side.
Represents a custom strip line for an axis.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the object containing the current object.
Gets or sets the title for the strip line.
Gets or sets the orientation of the title text.
Gets the object defining line style properties for the tick marks.
Gets the object defining actions for the strip line.
Gets or sets the tool tip to display for the strip line.
Gets or sets the size of the strip line.
Default: 0.
Gets or sets the units for the .
Default: Auto. Interval unit is derived automatically based on the data plotted against the axis.
Gets or sets the offset from the previous strip line or axis min (for the first strip line).
Default: 0.
Gets or sets the units for the .
Default: . The unit is derived automatically based on the data plotted against the axis.
Gets or sets the width of the strip line.
Default: 0.
Gets or sets the units for the .
Default: . The unit is derived automatically based on the data plotted against the axis.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets the object owning this collection.
Gets or sets the at the specified index.
Specifies types of arrows for axis labels.
No arrows.
Triangle arrows.
Sharp triangle arrows.
Lines only.
Specifies the step by which axis labels can be incrementally
rotated to fit within the chart.
Rotate in 90 degree increments.
Rotate in 30 degree increments
Rotate in 45 degree increments
Rotation is not allowed.
Represents properties of labels, titles and gridlines along an axis.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets a value indicating whether the axis is displayed.
Default: .
Gets the object defining text style properties for the axis labels and
line style properties for the axis line.
Gets the object defining a title of the axis.
Gets or sets a value indicating whether an axis margin will be created.
The size of the margin is automatically generated based on the scale
and the number of data points.
Default: .
Gets or sets the default interval between gridlines, tick marks and labels.
Default (0) means that the axis is autodivided.
Gets or sets the default unit for the .
Gets or sets the default offset for the first tick mark from the axis min.
Default: 0.
Gets or sets the default unit for the .
Gets or sets a value indicating whether if an automatic interval is calculated,
it should be based on available size.
Otherwise, the interval will be calculated based only on the data range.
Gets or sets the interval between labels.
Default (0) uses
Gets or sets the unit for the .
Gets or sets the offset for the first label from the axis min.
Default (0) uses .
Gets or sets the unit for the .
Gets the object defining how major gridlines
should be displayed for this axis.
Gets the object defining how minor gridlines
should be displayed for this axis.
Gets the object defining major tick marks for the axis.
Gets the object defining minor tick marks for the axis.
Gets or sets a value indicating whether the marks should stay with the edge of the plot area
rather than move with the axis.
Default: False.
Gets or sets a value indicating whether the axis should be plotted in the reverse direction.
Default: False.
Gets or sets the value (that evaluates to a double or to a DateTime) at which to cross the other axis.
If null (or error in expression), uses the default behavior for the chart type.
Overrides .
Gets or sets a value indicating whether the axis is drawn on the default side
(for example, left for the value axis on a line chart) or on the opposite side.
If this property is true then strip lines are drawn at every other grid line interval for the axis.
If grid lines are not used for the axis then the axis' tick marks or labels
are used to determine the interlaced strip lines interval.
Default: False.
Gets or sets the color of the interlaced strips.
Gets the collection defining
custom strip lines for the axis.
Gets or sets the type of arrows for axis labels.
Default: None.
Gets or sets a value indicating whether the values along this axis are scalar values
(that is, numeric or date) which should be displayed on the chart in a
continuous axis. Scalar cannot be true if the axis has more than one group,
if it has a static group or a group with more than one group expression.
The type of scalar (date, integer, float) is derived from the first non-null
value found. All values are converted to that type.
If any non-scalar value is present, the axis will
revert to non-scalar. Treated as True if this is a ChartCategoryAxis
and any ChartSeries plotted against this axis contains a ChartDataPoint
with ChartDataPointValues.X defined.
Gets or sets the minimum value for the axis.
If null (which is the default) or error in expression, the axis autoscales.
Gets or sets the maximum value for the axis.
If null (which is the default) or error in expression, the axis autoscales.
Gets or sets a value indicating whether the axis is logarithmic.
Default: False.
Gets or sets the base to use for the logarithmic scale.
Default: 10.
Gets or sets a value indicating whether the axis labels are hidden.
Gets or sets the angle at which to display axis labels.
This must be an integer between –90 and 90.
Default: 0
Gets or sets a value indicating whether the axis label font size should
not be reduced to fit within the chart.
Default: False.
Gets or sets a value indicating whether the axis label font size should
not be increased to fit within the chart.
Default: False.
Gets or sets a value indicating whether the axis labels should not be
staggered to fit within the chart.
Gets or sets a value indicating whether the axis labels should not be
word-wrapped to fit within the chart.
Gets or sets the step by which axis labels can be incrementally rotated to fit within the chart.
Default: .
Gets or sets a value indicating whether the axis should always include zero.
Ignored if Minimum is set.
Default: True.
Gets or sets a value indicating axis labels should not be automatically adjusted to fit.
Default: False.
Gets or sets the minimum font size when autofitting labels.
Default: 6pt.
Gets or sets the minimum font size when autofitting labels.
Default: 10pt.
Gets or sets a value indicating whether the labels should be offset.
Default: False.
Gets or sets a value indicating whether the labels should be hidden at axis ends.
Default: False.
Gets the object defining scale break behavior for the axis.
Gets the collection defining custom properties for the axis.
Represents collection of the objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Finds the with the specified name.
The name of the axis to locate.
The specified item
Gets a value indicating whether an axis with the name "Primary" exists in the collection.
Gets the object representing the primary axis.
Gets a value indicating whether an axis with the name "Secondary" exists in the collection.
Gets the object representing the secondary axis.
Gets or sets the at the specified index.
Specifies projection modes used for 3D rendering.
Use an oblique projection.
Use a perspective projection.
Specifies types of 3D shading.
Realistic shading.
Simplified shading.
No shading.
Represents properties for a 3D layout.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets a value indicating whether the chart is displayed in 3D.
Default: False (i.e. 2D).
Gets or sets the projection mode used for the 3D rendering.
Default: .
Gets or sets the percent of perspective. Applies only if perspective projection is used
(i.e. when is ).
Default: 0.
Gets or sets the rotation angle.
Default: 30.
Gets or sets the inclination angle.
Default: 30.
Gets or sets the ratio (in percent) between depth and width.
Default: 100.
Gets or sets the type of 3D shading.
Default: .
Gets or sets the depth gap between 3D bars and columns, in percent.
Default: 100.
Gets or sets the thickness of outer walls, in percent.
Default: 7.
Gets or sets a value that determines whether data series are clustered (displayed along distinct rows).
Only applies to bar and column chart types.
Default: False.
Specifies directions in which the chart area should be aligned with the target chart area.
No alignment.
Vertical alignment.
Horizontal alignment.
Both vertical and horizontal alignment.
Defines the position in which to draw a chart element.
Initializes a new instance of the class.
Initializes a new instance of the class.
Value assigned to the property.
Value assigned to the property.
Value assigned to the property.
Value assigned to the property.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the distance of the item from the top of the containing object,
as a percentage of the container's size.
Default is 0.
Gets or sets the distance of the item from the left of the containing object,
as a percentage of the container's size.
Default is 0.
Gets ot sets the width of the item as a percentage of its containing object's size.
If set to null (default), the value of 100 minus is used.
Gets ot sets the height of the item as a percentage of its containing object's size.
If set to null (default), the value of 100 minus is used.
Represents properties that determine which aspects of the chart area should be aligned with the target chart area.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets a value indicating whether the chart areas should align on axes views.
Gets or sets a value indicating whether the chart areas should align on cursors.
Gets or sets a value indicating whether the chart areas should align on chart area positions.
Gets or sets a value indicating whether the chart areas should align on inner plot positions.
Specifies border skin types for a chart.
No border skin.
Emboss border skin.
Raised border skin.
Sunken border skin.
FrameThin1 border skin.
FrameThin2 border skin.
FrameThin3 border skin.
FrameThin4 border skin.
FrameThin5 border skin.
FrameThin6 border skin.
FrameTitle1 border skin.
FrameTitle2 border skin.
FrameTitle3 border skin.
FrameTitle4 border skin.
FrameTitle5 border skin.
FrameTitle6 border skin.
FrameTitle7 border skin.
FrameTitle8 border skin.
Represents properties that determine the appearance of the border skin around the plot area.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the border skin type for the chart.
Gets the object defining style properties for the border skin.
Specifies automatic position for chart elements such as legend, title etc.
Top center position.
Top left position.
Top right position.
Left top position.
Left center position.
Left bottom position.
Right top position.
Right center position.
Right bottom position.
Bottom right position.
Bottom center position.
Bottom left position.
Specifies text orientation.
Indicates that orientation will be selected automatically based
on the context (for example, Rotated270 for titles docked on the left).
Horizontal text.
Vertical text – Rotated 90 degrees.
Vertical text – Rotated 270 degrees.
Vertical text – No character rotation.
Represents a title for the chart.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the tooltip to display for the title.
Gets or sets the caption of the title.
Gets or sets a value indicating whether the title should be hidden.
Gets the object defining style properties for the title.
Gets or sets the position of the title.
Gets or sets the name of the chart area on which to draw the title.
If omitted (or does not match any chart area name),
the title is drawn relative to the chart rather than a specific chart area.
Gets or sets a value indicating whether the title should be docked outside the chart
area rather than inside the chart area.
Ignored if is not set.
Gets or sets the offset from the dock location, as a percentage of the chart size.
Default: 0.
Gets or sets the object defining
custom position of the title.
If omitted, automatic positioning will be used.
Gets the object defining actions for the title.
Gets or sets the orientation of the text.
Representsf a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
Represents a title that is displayed if the chart contains no data.
Initializes a new instance of the class.
Specifies types of arrangement of labels within a legend.
Automatically arrange labels to fit.
Arrange labels in a column.
Arrange labels in a row.
Arrange labels in a wide table.
Arrange labels in a tall table.
Specifies types of lines used as separators in a chart.
No line.
Line.
Thick line.
Double line.
Dash line.
Dot line.
Gradient line.
Thick gradient line.
Represents a title for a legend.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the caption of the title.
Gets or sets a value indicating what type of separator to use for the legend title.
Gets the object defining style properties for the title.
Represents properties that can be used to display instances of the
series groups in a chart legend.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets a value indicating whether the legend is hidden.
Gets the object defining style properties for the legend.
Gets or sets the position of the legend.
Default: .
Gets or sets the arrangement of labels within the legend.
Default: .
Gets or sets the name of the chart area on which to draw the legend.
If omitted (or does not match any chart area name),
the legend is drawn relative to the chart rather than a specific chart area.
Gets or sets a value indicating whether the title should be docked outside
the chart area rather than inside the chart area.
Ignored if is not set.
Gets or sets the object defining
a custom position for the legend.
If null, automatic positioning will be used.
Gets the object defining properties
of the legend's title.
Gets or sets a value indicating whether to NOT autosize text
to fit in the legend area.
Default: False.
Gets or sets the minimum size for autosized legend text.
Default: 7pt.
Gets or sets the type of separator to use for the legend header.
Default: .
Gets or sets the color to use for the legend header separator.
Default: Black.
Gets or sets the type of separator to use for the columns.
Default: .
Gets or sets the color to use for the column separator.
Default: Black.
Gets or sets the spacing between columns as percentage of the font size.
Default: 50.
Gets or sets a value indicating whether legend rows should use interlaced colors.
Gets or sets the background color to use for interlaced legend rows.
If null (default), the chart area background color will be used.
Gets or sets a value indicating whether legend items should be equally spaced.
Default: False.
Gets or sets a value indicating that the direction of the legend should be reversed.
Default: Auto.
Gets or sets the maximum size for the legend, as percentage of the chart size.
Default: 50.
Gets or sets the number of characters after which to wrap the legend text.
Default: 25
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
Represents the chart that is drawn within a 's data region.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets a value indicating whether the chart area should be hidden.
Gets the collection defining the category axes.
Gets the collection defining the value axes.
Gets the object defining properties for a 3D chart layout.
Gets the object defining style properties for the chart area.
Gets or sets a value indicating in which directions the chart
area should be aligned with the target chart area.
Ignored if is not set.
Gets the object defining which aspects of the
chart area should be aligned with the target chart area.
Ignored if is not set.
Gets or sets the name of a chart area with which to align this chart area.
Gets or sets the object
defining a custom position for the chart area.
If null, automatic positioning will be used.
Gets or sets the object
defines a custom position for the inner plot area.
If null, automatic positioning will be used.
Gets or sets a value indicating that
the same font size should be used for all axes
(if the font size is automatic).
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
Gets the with specified name.
Represents a category or series member for a .
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the collection owning this object.
Gets the object containing this object.
Gets the object containing this object.
Gets the object contaning this object.
Gets the object defining data grouping.
If is null, this is a static member
(otherwise, this is a dynamic member).
Not allowed if any ancestor group is a detail group.
Gets the collection containing
the expressions by which to sort the group instances.
Not used if is null.
Gets the collection containing
submembers contained within this member.
Gets the collection
with custom properties for the member.
Gets or sets the label displayed on the legend (for series members and category members
with ) or category axis (for category members).
Gets or sets the name to use for the data element for this member.
Must be a CLS-compliant identifier.
Gets or sets a value indicating whether the member should appear in a data rendering.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets the object containing this object.
Gets the object containing this object.
Gets or sets the at the specified index.
Represents a hierarchy of members for the .
Copies properties from another to the current object.
The source object to copy properties from.
Gets the object owning this object.
Gets the object containing this object.
Gets the collection containing
an ordered list of members of a tablix hierarchy.
Specifies color palettes for chart items.
Default palette.
EarthTones palette.
Excel palette.
GrayScale palette.
Light palette.
Pastel palette.
SemiTransparent palette.
Berry palette.
Chocolate palette.
Fire palette.
SeaGreen palette.
BrightPastel palette.
Custom palette.
Specifies how hatching is applied to data points in the chart.
Default. Treated as None.
No hatching is added to the data points.
Automatic hatching is applied to all data points (unless BackgroundHatchType is specified as non-Default).
Represents a set of data values for a data point in the chart.
Each series type has a different set of mandatory and optional data values.
Data values not used for the series type are ignored.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the X value for the data point.
Mandatory in series with Type = Scatter.
Gets or sets the Y value for the data point.
Mandatory in series with Type not equal to Range,
and with Type equal to Range with Subtype = ErrorBar.
Gets or sets the size value for the data point.
Optional in series with Type = Scatter with Subtype = Bubble.
Gets or sets the high value for the data point.
Mandatory in series with Type = Range.
May be omitted if Y is specified. If so, it defaults to Y.
Gets or sets the high value for the data point.
Mandatory in series with Type = Range.
May be omitted if Y is specified. If so, it defaults to Y.
Gets or sets the start/open value for the data point.
Optional in series with Type = Range with SubType = Stock,
Candlestick or BoxPlot.
Gets or sets the end/close value for the data point.
Optional in series with Type = Range with SubType = Stock,
Candlestick or BoxPlot.
Gets or sets the mean value for the data point.
Optional in series with Type = Range with SubType = BoxPlot.
Gets or sets the median value for the data point.
Optional in series with Type = Range with SubType = BoxPlot.
Specifies positions of a label.
Default.
Position label at Top of data point.
Position label at TopLeft of data point.
Position label at TopRight of data point.
Position label at Left of data point.
Position label at Center of data point.
Position label at Right of data point
Position label at BottomRight of data point.
Position label at Bottom of data point.
Position label at BottomLeft of data point.
Position label Outside of data point For non-Pie charts,
Outside is treated as Top.
Represents data labels to display on data values.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the object defining style properties for the labels.
If specified, this style overrides Series styles.
Gets or sets a value indicating the Y value of the data point should be used as the label.
Default: False.
Gets or sets the label for the data point.
Not used if is True
Gets or sets a value indicating whether the data label is displayed on the chart.
Default: False.
Gets or sets the position of the label.
Default: Auto.
Gets or sets the angle of rotation of the label text.
Default: 0.
Gets or sets the tooltip to display for the data label.
Gets the object
defining actions associated with this data label.
Specifies the marker types for displayed chart values.
No marker.
Square marker.
Circle marker.
Diamond marker.
Triangle marker.
Cross marker.
Star (4 points) marker.
Star (5 points) marker.
Star (6 points) marker.
Star (10 points) marker.
Automatically cycle through marker types for each series.
Represents a marker for displayed chart values.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the marker type for values.
Gets or sets the height and width of the plotting area of marker(s).
Gets the object determining the style properties for the marker.
Represents the behavior for a series or set of data points displayed in a legend.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the label to use in the legend for the item for .
If this property is not set, the Label properties from
the chart categories hierarchy are used as the legend text
(with " – " added between each pair).
Gets or sets the tooltip to display for the item in the legend.
Gets the object associated with the item in the legend.
Gets or sets a value indicating whether the item should not be shown in the legend.
Specifies vertical alignment of data point labels placed inside the funnel or pyramid.
Center alignment.
Top alignment.
Bottom alignment.
Specifies Funnel or Pyramid chart data point labels style.
Labels are inside.
Labels are outside.
Labels are outside in column.
Labels are disabled.
Specifies outside labels placement, relative to the funnel or pyramid.
Labels on the right.
Labels on the left.
Base class for custom properties of the and .
Base class for custom properties of data point of chart.
Gets object owning this object.
Represents custom attributes of a object.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Properties of data point of the Column chart.
Properties of data point of the Column Stacked chart.
Properties of data point of the Column PercentStacked chart.
Properties of data point of the Line chart.
Properties of data point of the Line Smooth chart.
Properties of data point of the Line Stepped chart.
Properties of data point of the Pie chart.
Properties of data point of the Doughnut chart.
Properties of data point of the Funnel chart.
Properties of data point of the Pyramid chart.
Properties of data point of the Bar chart.
Properties of data point of the Bar Stacked chart.
Properties of data point of the Bar Percent Stacked chart.
Properties of data point of the Area chart.
Properties of data point of the Area Smooth chart.
Properties of data point of the Area Stacked chart.
Properties of data point of the Area Percent Stacked chart.
Properties of data point of the Range chart.
Properties of data point of the Range Smooth chart.
Properties of data point of the Range Column chart.
Properties of data point of the Range Bar chart.
Properties of data point of the Range Candlestick chart.
Properties of data point of the Range BoxPlot chart.
Properties of data point of the Range ErrorBar chart.
Properties of data point of the Range Stock chart.
Properties of data point of the Scatter chart.
Properties of data point of the Scatter Bubble chart.
Properties of data point of the Polar chart.
Properties of data point of the Radar chart.
Base class for custom properties of data point of chart.
Gets owning this object.
Common properties for data point of Area charts.
Properties of data point of Area chart.
Gets or set the data point labels position.
Default: Auto.
Determines if marker lines are displayed.
Default: False.
Properties of data point of Area Smooth chart.
Properties of Area Stacked chart.
Properties of Area PercentStacked chart.
Common properties of data point of the Column and Bar charts.
Gets or sets the drawing style of bar or column charts.
Default: Default.
Properties of data point of the Column chart.
Gets or set the data point labels position.
Default: Auto.
Properties of data point of the Column Stacked chart.
Properties of data point of the Column PercentStacked chart.
Common properties of data point of Bar charts.
Gets or sets the data point label placement.
Default: Outside.
Properties of data point of Bar chart.
Properties of data point of Bar Stacked props.
Properties of Bar PercentStacked props.
Base properties of Line chart.
Gets or set the data point labels position.
Default: Auto.
Determines if marker lines are displayed.
Default: False.
Properties of Line Smooth chart.
Properties of Line Stepped chart.
Properties of data point of Pie chart.
Determines if a Pie or Doughnut slice is exploded.
Default: false.
Gets or sets the horizontal callout line size. This attribute is only applied
if labels are drawn outside of data points.
Default: 1.
Gets or sets the radial callout line size. This attribute is only applied if
labels are drawn outside of data points.
Default: 1.
Gets or sets the data point labels position.
Default: Default.
Gets or sets the color of the radial and horizontal label lines.
Default: Color.Empty(auto color).
Properties of data point of Doughnut charts.
Common properties of data point of Funnel and Pyramid charts.
Gets or sets the CalloutLineColor for the data point labels of Funnel or Pyramid charts.
Default: Color.Empty (auto color).
Properties of Funnel chart.
Gets or sets the vertical alignment of data point labels placed inside the funnel.
Default: Center.
Gets or sets a Funnel chart data point labels style.
Default: OutsideInColumn.
Gets or sets the outside labels placement, relative to the funnel.
Default: Right.
Properties of data point of Pyramid chart.
Gets or sets the vertical alignment of data point labels placed inside the pyramid.
Default: Center.
Gets or sets a Pyramid chart data point labels style.
Default: OutsideInColumn.
Gets or sets the outside labels placement, relative to the pyramid.
Default: Right.
Properties of data point of Range chart.
Gets or set the data point labels position.
Default: Auto.
Properties of data point of smooth Range chart.
Properties of data point of the Range Column chart.
Gets or sets the drawing style of bar or column charts.
Default: Default.
Properties of data point of the Range Bar chart.
Gets or sets the data point label placement.
Default: Center.
Properties of data point of the Range Stock chart.
Gets or sets the Y value that is used as a data label.
Default: Close.
Gets or sets the marker style when is Open or Close values.
Default: Line.
Determines if Open and Close markers (lines or triangles) are displayed
while is Open or Close.
Default: Both.
Properties of data point of the Range Candlestick chart.
Gets or sets the Y value that is used as a data label.
Default: Close.
Gets or sets the color for a candle if a data point's Close value is less than its Open value.
Default: Empty (auto).
Gets or sets the color for a candle if a data point's Close value is greater than its Open value.
Default: Empty (auto).
Properties of data point of the Range ErrorBar chart.
Gets or sets the appearance type of the marker shown at the center value of the Error Bar chart.
Default: Line.
Gets or sets the visibility of the Upper and Lower Error values of an Error Bar chart.
Default: Both.
Properties of data point of the Range BoxPlot chart.
Properties of the Scatter chart.
Gets or set the data point labels position.
Default: Auto.
Properties of the Scatter Bubble chart.
Properties of data point of the Polar charts.
Gets or set the data point labels position.
Properties of data point the Radar chart.
Represents a data point for a chart.
May consist of a single value expression
(for example in bar or line charts) or
multiple value expressions (stock and bubble charts).
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the collection containing this object.
Gets the object defining data values for the point.
Gets the object defining data labels.
Gets or sets the label to use on the axis for the data point.
Gets or sets the tooltip to display for the data point.
Gets the object defining actions associated with this data point.
Gets the object defining style properties for the data point.
Gets the object defining appearance of the data point marker.
Gets or sets the name to use for the data element for this member.
Must be a CLS-compliant identifier.
Gets or sets a value indicating whether the member should appear in a data rendering.
Gets the defining how the data point
appears when displayed in a legend (when Series.Type = Shape).
Gets the object defining
custom properties for the data point.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets object owning this collection.
Gets or sets the at the specified index.
Specifies visualization types for the series.
Column chart.
Bar chart.
Line chart.
Shape chart.
Scatter chart.
Area chart.
Range chart.
Polar chart.
Specifies visualization subtypes for the series.
Available subtypes (and default subtype) depends on .
Default for all Types except Shape.
For Column, Bar and Area.
For Column, Bar and Area.
For Line, Area and Range.
For Line only.
Default for Shape.
For Shape only.
For Shape only.
For Shape only.
For Shape only.
For Shape only.
For Scatter only.
For Range only.
For Range only.
For Range only.
For Range only.
For Range only.
For Range only.
For Polar only.
Represents the behavior for empty points in a series.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the object defining style properties for the data point.
Gets the object defining appearance of the data point marker.
Gets the object indicating that the values should be marked with data labels.
Gets or sets the label to use on the axis for empty data points.
Gets or sets the tooltip to display for the data point.
Gets the object defining actions associated with this data point.
Gets the collection containing
custom properties for the data point.
Specifies how datapoint labels can be drawn outside of the plot area.
Labels can be partially outside the plot area.
Labels can be entirely outside the plot area.
Labels must be entirely inside the plot area.
Specifies shapes that should be drawn on the point end of the callout line.
None.
Arrow.
Diamond.
Square.
Round.
Specifies styles to use when drawing the callout lines.
Attach the callout line to an underline on the label.
Attach the callout line to a box around the label.
No additional label style for the callout line.
Represents directions in which a smart label is not allowed to move.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets a value indicating whether the smart label is not allowed to move directly up.
Gets or sets a value indicating whether the smart label is not allowed to move directly left.
Gets or sets a value indicating whether the smart label is not allowed to move directly right.
Gets or sets a value indicating whether the smart label is not allowed to move directly down.
Gets or sets a value indicating whether the smart label is not allowed to move up-left.
Gets or sets a value indicating whether the smart label is not allowed to move up-right.
Gets or sets a value indicating whether the smart label is not allowed to move down-left.
Gets or sets a value indicating whether the smart label is not allowed to move down-right.
Represents the behavior of smart labels.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets a value indicating whether smart labels should be turned off.
Gets or sets a value indicating whether datapoint labels can be drawn outside of the plot area.
Gets or sets the fill color of the box around the point label text when the is Box.
Gets or sets the shape that should be drawn on the point end of the callout line.
Gets or sets a value indicating whether datapoint labels can be drawn outside of the plot area.
Gets or sets the style of the callout line.
Default: Solid.
Gets or sets the width of the callout line.
Default: 0.75pt.
Gets or sets the style to use when drawing the callout lines.
Default: Underline.
Gets or sets a value indicating labels should be displayed even when
overlapping issues cannot be resolved.
Default: False.
Gets or sets a value indicating whether point labels are allowed to overlap point markers.
Default: False.
Gets or sets the maximum distance from the data point that data point labels
can be moved to prevent overlapping.
Default: 23 pt.
Gets or sets the minimum distance from the data point that data point labels
can be moved to prevent overlapping.
Default: 23 pt.
Gets the object indicating in which directions
the label is not allowed to move.
Specifies possible drawing styles of the .
Default.
Cylinder.
Emboss.
Light to dark.
Wedge.
Specifies empty point value for chart series.
Zero.
Average.
Specifies column style for chart series.
Normal.
Paretto.
Histogram.
Specifies types of shapes of a Radar chart's chart area.
Circular shape.
Polygon shape.
Specifies types of arrowhead to use for line segments that join labels
to their data points.
No arrowheads.
Triangle arrowheads.
Sharp arrowheads.
Line arrowheads.
Specifies data point label placement for Bar and Gantt charts.
Labels are outside.
Labels are on the left.
Labels are on the right.
Labels are centered.
Specifies styles of collected slice.
No slice.
Single slice.
Collected pie.
Specifies drawing styles for Pie and Doughnut charts.
Default.
Soft edge.
Concave.
Specifies data point labels position for Pie and Doughnut charts.
Labels are inside.
Lables are outside.
Labels are disabled.
Specifies drawing styles for 3D Funnel and Pyramid charts.
Circular base style.
Square base style.
Specifies styles of Funnel and Pyramid charts.
Y is the width.
Y is the height.
Specifies types of data represeted by a pyramid chart: linear height of the segment or it's surface.
Linear height is the data.
Surface is the data.
Specifies Y values that used as a data label in Range Stock charts.
High.
Low.
Open.
Close.
Specifies marker styles in Range Stock charts.
Triangle.
Line.
Candlestick.
Specifies show behavior for markers in Range Stock charts.
Both.
Open.
Close.
Specifies styles of center marker for Range ErrorBar charts.
None.
Line.
Square.
Circle.
Diamond.
Triangle.
Cross.
Star4.
Star5.
Star6.
Star10.
Specifies visibility behavior of the Upper and Lower Error values of an Error Bar chart.
Both error values are visible.
Upper error value is visible.
Lower error value is visible.
Specifies modes of calculation of the upper and lower errors for the center values of an error bar series.
Fixed value.
Percentage.
Standard deviation.
Standard error.
Specifies positions of data labels for Polar and Radar charts.
Auto.
Circular.
Horizontal.
Radial.
Specifies drawing styles of Polar charts.
Line.
Marker.
Specifies drawing styles of Radar charts.
Area.
Line.
Marker.
Represents custom attributes of a object.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Properties of the Column chart.
Properties of the Column Stacked chart.
Properties of the Column PercentStacked chart.
Properties of the Line chart.
Properties of the Line Smooth chart.
Properties of the Line Stepped chart.
Properties of the Pie chart.
Properties of the Doughnut chart.
Properties of the Funnel chart.
Properties of the Pyramid chart.
Properties of the Bar chart.
Properties of the Bar Stacked chart.
Properties of the Bar Percent Stacked chart.
Properties of the Area chart.
Properties of the Area Smooth chart.
Properties of the Area Stacked chart.
Properties of the Area Percent Stacked chart.
Properties of the Range chart.
Properties of the Range Smooth chart.
Properties of the Range Column chart.
Properties of the Range Bar chart.
Properties of the Range Candlestick chart.
Properties of the Range BoxPlot chart.
Properties of the Range ErrorBar chart.
Properties of the Range Stock chart.
Properties of the Scatter chart.
Properties of the Scatter Bubble chart.
Properties of the Polar chart.
Properties of the Radar chart.
Abstract base class for chart of specified type.
Gets owning this object.
Common 3D properties for Column, Bar, Line, Area charts.
Gets or sets the 3D series depth, measured in pixels.
Default: 0.
Gets or sets the 3D series gap, measured in pixels.
Default: 0.
Common properties for Area charts.
Properties of Area chart.
Determines how an empty point is treated when the chart is drawn.
If a value of 'Average' is used then the chart is drawn as if a point exists
that has an average Y value, the average being calculated using the adjacent points.
If 'Zero' is used then the chart is drawn as if a point exists with a value of zero.
Default: Average.
Gets or set the data point labels position.
Default: Auto.
Determines if marker lines are displayed.
Default: False.
Properties of Area Smooth chart.
Gets or sets the tension for the drawn curve.
A curve with zero tension will have the appearance of a line.
Applied only for smooth chart.
Default: 0.5.
Properties of Area Stacked chart.
Properties of Area PercentStacked chart.
Common properties of the Column and Bar charts.
Gets or sets the drawing style of bar or column charts.
Default: Default.
Gets or sets the maximum width (in pixels) of data points.
Default: 0.
Gets or sets the minimum width (in pixels) of data points.
Default: 0.
Gets or sets the width (in pixels) of data points.
Default: 0.
Gets or sets the relative width of data points.
Default: 0.8.
Properties of the Column chart.
Determines if data points that have the same X value are drawn side by side,
or are drawn using the same X value.
If Auto then the chart type automatically determines if this is true or false.
Note that setting this attribute to true only has an effect
if two or more series in a chart area have DrawSideBySide set to true.
Default: Auto.
Determines how an empty point is treated when the chart is drawn.
If a value of 'Average' is used then the chart is drawn as if a point exists
that has an average Y value, the average being calculated using the adjacent points.
If 'Zero' is used then the chart is drawn as if a point exists with a value of zero.
Default: Average.
Gets or set the data point labels position.
Default: Auto.
Series will be formatted as Normal, Histogram or Pareto after binding the
data to the series.
This attribute will be ignored if Series groupings or nested Category groupings
exist.
Default: Normal.
If is Histogram, then this property defines the
number of intervals the data range is divided into.
This property only has effect when is not set.
Default: 20.
If is Histogram then this property defines the histogram interval width.
Setting this value to 0 will result in automatic width calculation based on the
data range.
Default: 0.
If is Histogram then this property indicates the
percent frequency should be displayed using the secondary Y axis.
Default: True.
Properties of the Column Stacked chart.
Gets or sets the stacked column group name.
Properties of the Column PercentStacked chart.
Common properties of Bar charts.
Gets or sets the data point label placement.
Default: Outside.
Properties of Bar chart.
Determines if data points that have the same X value are drawn side by side,
or are drawn using the same X value.
If Auto then the chart type automatically determines if this is true or false.
Note that setting this attribute to true only has an effect
if two or more series in a chart area have DrawSideBySide set to true.
Default: Auto.
Determines how an empty point is treated when the chart is drawn.
If a value of 'Average' is used then the chart is drawn as if a point exists
that has an average Y value, the average being calculated using the adjacent points.
If 'Zero' is used then the chart is drawn as if a point exists with a value of zero.
Default: Average.
Properties of Bar Stacked props.
Gets or sets the stacked bar group name.
Properties of Bar PercentStacked props.
Base properties of Line chart.
Determines how an empty point is treated when the chart is drawn.
If a value of 'Average' is used then the chart is drawn as if a point exists
that has an average Y value, the average being calculated using the adjacent points.
If 'Zero' is used then the chart is drawn as if a point exists with a value of zero.
Default: Average.
Gets or set the data point labels position.
Default: Auto.
Determines if marker lines are displayed.
Default: False.
Properties of Line Smooth chart.
Gets or sets the tension for the drawn curve. A curve with zero tension will have the appearance of a line.
Default: 0.5.
Properties of Line Stepped chart.
Properties of Pie chart.
Gets or sets the 3D label line size as a percentage of the default size.
Default: 100.
Gets or sets the style of collected style.
Default: None.
Gets or sets the color of the collected pie or doughnut slice.
Default: Color.Empty.
Gets or sets the label of the collected pie slice.
Default: "Other".
Gets or sets the legend text of the collected pie slice.
Default: "Other".
Gets or sets a Boolean value that indicates whether the
collected pie slice will be shown as exploded.
Default: False.
Gets or sets the threshold value for collecting small pie slices.
Default: 5.
Gets or sets value that indicates if collected slice threshold value (see )
is set in percent.
Default: True.
Gets or sets collected slice tooltip.
Default: True.
Displays point label for the collected pie (if slices have been collected).
Default: False.
Displays a legend for the collected pie (if slices have been collected).
Default: False.
Gets or sets the horizontal callout line size. This attribute is only applied
if labels are drawn outside of data points.
Default: 1.
Gets or sets the radial callout line size. This attribute is only applied if
labels are drawn outside of data points.
Default: 1.
Gets or sets the minimum pie size. When used with outside labeling,
this property controls the minimum acceptable pie size, measured as
a percentage the chart area size.
This will prevent the pie from becoming too small due to the labels
dominating the chart area.
Default: 30.
Gets or sets the drawing style of the Pie and Doughnut charts.
Default: Default.
Gets or sets the data point labels position.
Default: Default.
Gets or sets the color of the radial and horizontal label lines.
Default: Color.Empty(auto color).
Determines the starting angle of the first pie slice, measured in degrees.
Default: 0.
Properties of Doughnut charts.
Percent of the radius used as the doughnut size.
Default: 60.
Common properties of Funnel and Pyramid charts.
Gets or sets the CalloutLineColor for the data point labels of Funnel or Pyramid charts.
Default: Color.Empty (auto color).
Properties of Funnel chart.
Gets or sets the drawing style of a Funnel 3D chart.
Default: CircleBase.
Gets or sets the 3D rotation angle of the funnel.
Default: 5.
Gets or sets the vertical alignment of data point labels placed inside the funnel.
Default: Center.
Gets or sets a Funnel chart data point labels style.
Default: OutsideInColumn.
Gets or sets the minimum height of data points, in relative coordinates.
This attribute can be used to make very small funnel segments visible.
Default: 0.
Gets or sets the funnel neck height.
Only applied when a predefined funnel shape is used.
Default: 5.
Gets or sets the funnel neck width.
Only applied when a predefined funnel shape is used.
Default: 5.
Gets or sets the outside labels placement, relative to the funnel.
Default: Right.
Gets or sets the gap size between points, in relative coordinates.
Default: 0.
Gets or sets the Funnel chart style.
Default: YIsHeight.
Properties of Pyramid chart.
Gets or sets the drawing style of a 3D Pyramid chart.
Default: SquareBase.
Gets or sets the 3D rotation angle of the pyramid.
Default: 5.
Gets or sets the vertical alignment of data point labels placed inside the pyramid.
Default: Center.
Gets or sets a Pyramid chart data point labels style.
Default: OutsideInColumn.
Gets or sets the minimum height of data points, in relative coordinates.
This attribute can be used to make very small pyramid segments visible.
Default: 0.
Gets or sets the outside labels placement, relative to the pyramid.
Default: Right.
Gets or sets the gap size between points, in relative coordinates.
Default: 0.
Gets or sets if data point values represent a linear height of the segment or it's surface.
Default: Linear.
Properties of Range chart.
Determines how an empty point is treated when the chart is drawn.
If a value of 'Average' is used then the chart is drawn as if a point exists
that has an average Y value, the average being calculated using the adjacent points.
If 'Zero' is used then the chart is drawn as if a point exists with a value of zero.
Default: Average.
Gets or set the data point labels position.
Default: Auto.
Properties of smooth Range chart.
Gets or sets the tension for the drawn curve.
A curve with zero tension will have the appearance of a line.
Default: 0.5.
Common properties for Range charts like Column, Bar, Stock,
Candlestick, ErrorBar, BoxPlot.
Gets or sets the maximum width (in pixels) of data points.
Default: 0.
Gets or sets the minimum width (in pixels) of data points.
Default: 0.
Gets or sets the width (in pixels) of data points.
Default: 0.
Gets or sets the relative width of data points.
Default: 0.8.
Properties of the Range Column chart.
Gets or sets the drawing style of bar or column charts.
Default: Default.
Determines if data points that have the same X value are drawn side by side,
or are drawn using the same X value.
If Auto then the chart type automatically determines if this is true or false.
Note that setting this attribute to true only has an effect
if two or more series in a chart area have DrawSideBySide set to true.
Default: Auto.
Determines how an empty point is treated when the chart is drawn.
If a value of 'Average' is used then the chart is drawn as if a point exists
that has an average Y value, the average being calculated using the adjacent points.
If 'Zero' is used then the chart is drawn as if a point exists with a value of zero.
Default: Average.
Properties of the Range Bar chart.
Gets or sets the data point label placement.
Default: Center.
Properties of the Range Stock chart.
Gets or sets the Y value that is used as a data label.
Default: Close.
Gets or sets the marker style when is Open or Close values.
Default: Line.
Determines if Open and Close markers (lines or triangles) are displayed
while is Open or Close.
Default: Both.
Properties of the Range Candlestick chart.
Gets or sets the Y value that is used as a data label.
Default: Close.
Gets or sets the color for a candle if a data point's Close value is less than its Open value.
Default: Empty (auto).
Gets or sets the color for a candle if a data point's Close value is greater than its Open value.
Default: Empty (auto).
Properties of the Range ErrorBar chart.
Determines if data points that have the same X value are drawn side by side,
or are drawn using the same X value.
If Auto then the chart type automatically determines if this is true or false.
Note that setting this attribute to true only has an effect
if two or more series in a chart area have DrawSideBySide set to true.
Default: Auto.
Gets or sets the appearance type of the marker shown at the center value of the Error Bar chart.
Default: Line.
Gets or sets the name of the series that will be used for error bar
calculations. The named series must exist.
Gets or sets the visibility of the Upper and Lower Error values of an Error Bar chart.
Default: Both.
Defines how the upper and lower errors are calculated for the center values of the error bar series.
Default: StandardError.
Properties of the Range BoxPlot chart.
Determines if data points that have the same X value are drawn side by side,
or are drawn using the same X value.
If Auto then the chart type automatically determines if this is true or false.
Note that setting this attribute to true only has an effect
if two or more series in a chart area have DrawSideBySide set to true.
Default: Auto.
Gets or sets the percentile value of the box of the Box chart.
Default: 25.
Gets or sets the name of the series to be used as the data source for the Box chart.
Gets or sets a value that indicates whether to display the average value
for the Box chart.
Default: true.
Gets or sets a value that indicates whether to display the median value for
the Box chart.
Default: true.
Gets or sets a value that indicates whether the unusual values value for
the Box chart will be shown.
Default: true.
Gets or sets the percentile value of the whiskers of the Box chart.
Applied for: Range:Box.
Default: true.
Properties of the Scatter chart.
Determines how an empty point is treated when the chart is drawn.
If a value of 'Average' is used then the chart is drawn as if a point exists
that has an average Y value, the average being calculated using the adjacent points.
If 'Zero' is used then the chart is drawn as if a point exists with a value of zero.
Default: Average.
Gets or set the data point labels position.
Default: Auto.
Properties of the Scatter Bubble chart.
Gets or sets the maximum size of the bubble radius as a percentage of the chart area size.
Default: 15.
Gets or sets the minimum size of the bubble radius as a percentage of the chart area size.
Default: 3.
Gets or sets the bubble size that will be used as the maximum,
which is a percentage of the chart area that is set by .
Default: 15.
Gets or sets the bubble size that will be used as the minimum,
which is a percentage of the chart area that is set by .
Default: 3.
Gets or sets a value that indicates whether to use the bubble size
as the data point label.
Default: false.
Common properties of the Polar and Radara charts.
Determines how an empty point is treated when the chart is drawn.
If a value of 'Average' is used then the chart is drawn as if a point exists
that has an average Y value, the average being calculated using the adjacent points.
If 'Zero' is used then the chart is drawn as if a point exists with a value of zero.
Default: Average.
Gets or set the data point labels position.
Gets or sets the plotting area shape of Radar and Polar charts.
Default: Circle.
Gets or sets the labels drawing style of Polar and Radata charts.
Default: Auto.
Properties of the Polar chart.
Gets or sets a Polar chart's drawing style.
Default: Line.
Properties of the Radar chart.
Gets or sets a Radar chart's drawing style.
Default: Area.
Defines the list of data points for one series.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets value indicating whether the series should be hidden.
Gets object containing data points within the series.
Gets or sets visualization type for the series.
Default: Column.
Gets or sets visualization subtype for the series.
Available subtypes (and default subtype) depends on .
By default this property is null it means that
default subtype for currently selected wiil be used.
Gets defining behavior of empty points in the series.
Gets defining style properties for the series.
Gets object indicating the values should be marked
with data labels.
Applies only within DerivedSeries.
Gets object defining appearance of the data point
marker.
Applies only within DerivedSeries.
Gets collection defining custom properties for the series.
This includes all custom chart attributes for series.
Gets object defining how the series
appears when displayed in a legend.
Gets or sets name of the legend in which this series should appear.
Gets or sets name of the chart area in which to plot the series.
Defaults (if null or empty) to the first chart area in the chart.
Gets or sets name of the value axis against which to plot this series.
If null or empty, the series should be plotted against the first value axis.
Gets or sets name of the category axis against which to plot this series.
If null or empty, the series should be plotted against the first category axis.
Gets smart label properties.
Represents collection of the objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
Defines a parameter to a formula for a derived series.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets value of the parameter if the value does not depend on
the actual data points.
Gets or sets name of the ChartDataPointValue property to use as the value of this parameter.
Represents collection of the objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
Specifies the formula applied to one or more chart series.
Bollinger Bands indicators are plotted at standard deviation levels above and
below a simple moving average.
A Simple Moving Average is an average of data calculated over a period of time.
The moving average is the most popular price indicator used in technical analysis,
and can be used with any price,
for example, Hi, Low, Open and Close, or can be applied to other indicators.
An Exponential Moving Average is an average of data calculated over a period
of time where the most recent days have more weight.
A Triangular Moving Average is an average of data calculated over a period
of time where the middle portion of data has more weight.
Weighted Moving Average is an average of data that is calculated over a period
of time, where greater weight is attached to the most recent data.
Moving Average Convergence/Divergence indicator compares two moving averages of
prices and is used with a 9-day Exponential Moving average as a signal that
indicates buying and selling moments.
Detrended Price Oscillator attempts to remove trends from prices.
Envelopes are plotted above and below a moving average by using a specified percentage as the shift.
The Performance indicator compares a current closing price or any other price
with the first closing value from the first time period.
The Rate of Change indicator compares a specified closing price with the
current price.
The Relative Strength Index is a momentum oscillator that compares upward
movements of the closing price with downward movements, and results in
values that range from 0 to 100.
Standard Deviation is used to indicate volatility, and measures the difference between values,
for example, closing price, and their moving average.
The Triple Exponential Moving Average is based on a triple moving average
of the closing price. Its purpose is to eliminate short cycles.
This indicator keeps the closing price in trends that are shorter
than the specified period.
Mean prices are average values of daily prices and can be used as a filter
for trend indicators.
Median prices are mid-point values of daily prices and can be used as
a filter for trend indicators.
Defines a derived series which is calculated from a formula
applied to another series.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets collection containing this object.
Gets object defining series properties for the derived series.
Gets or sets name of the series from which to derive.
Gets collection containing
parameters to the formula.
Gets or sets formula to apply to the data values from the source series.
Represents collection of the objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
Represents chart data.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets collection.
Gets collection containing
derived series which are calculated from formulas applied to other series.
Defines the custom color to use for the Custom palette of the object.
Initializes a new instance of the class.
Initializes a new instance of the class.
Value of property.
Copies properties from another to the current object.
The source object to copy properties from.
Gets object representing value of this object.
For internal use.
For internal use.
For internal use.
Defines the colors to use for the Custom palette of the object.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Adds a color to the current collection.
The color to add.
The index of the added color in the current collection.
Adds a value to the current collection.
The value to add.
The index of the added value in the current collection.
Gets the element at the specified index.
The index in the collection.
The element at the specified index.
The object defines a set of chart areas to be drawn as a single data visualization data region.
The is defined much like a , but instead of Columns, Rows, and Cells,
the has Categories, Series, and DataPoints.
Abstract base class for all report items linked with data.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the message to display in the
(instead of the region layout) when no rows of data are available.
Note: Style information on the data region applies to this text.
Gets or sets the name of the to use for this .
Mandatory for top level data regions (not contained within another DataRegion)
unless there is exactly one data set in the report. If there is exactly one
data set in the report, the data region uses that data set.
Note: If there are no data sets in the report,
data regions can not be used, as there is no valid DataSetName to use.
Ignored for data regions that are not top level.
Gets or sets the object
defining the page break behavior for the current data region.
Gets the collection containing filters
to apply to each row of data in the current data region.
Gets the collection containing expressions
by which to sort the rows of data in the current data region.
Initializes a new instance of the class.
For internal use.
For internal use.
Copies properties from another to the current object.
The source object to copy properties from.
Gets collection representing
the hierarchy of series members for the chart.
Gets collection representing
the hierarchy of category members for the chart.
Gets object defining the data values for the chart.
Gets collection containing
the set of chart areas for the chart.
Gets collection containing
the set of legends for the chart.
Gets collection containing
the set of titles for the chart.
Gets or sets the color palette for the chart items.
Gets or sets value indicating whether hatching should be
automatically applied to data points in the chart.
Default: Default (treated as None).
Gets or sets the height to which the chart should grow/shrink.
Height is used as the initial height for relative layout changes due
to resizing.
Gets or sets the width to which the chart should grow/shrink.
Width is used as the initial width for relative layout changes due
to resizing.
Gets object
defining a border skin for the chart.
Gets object
defining title to display if the chart contains no data.
Gets object containing custom palette colors.
Specifies types of image sizing.
The object should grow/shrink to accommodate the image.
The object is resized to exactly match the height and width of the image element.
The object should be resized to fit, preserving aspect ratio.
The object should be clipped to fit.
Representa an image in a report.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the source of the image.
-
The contains a constant or expression that evaluates to the location of the image. This can be a full folder path (for example, “/images/logo.gif”), relative path (for example, “logo.gif”) or URL (for example, “http://reportserver/images/logo.gif”). Relative paths start in the same folder as the report.
-
The contains a constant or expression that evaluates to the name of an in the report.
-
The contains an expression (a field in the database) that evaluates to the binary data for the image.
Gets or sets a value defining the image.
The interpretation of that value depends on .
Gets or sets the MIMEType for the image.
Required if is . Ignored otherwise.
Gets or sets a value defining the behavior if the image does not fit in the specified size.
Represents a line in a report.
The Line class has no additional properties beyond what it inherits from .
Negative heights/widths allow for lines that are drawn up and/or left from their origin.
Although negative Height and Width are allowed, both Top+Height and
Left+Width must be nonnegative valid sizes.
Initializes a new instance of the class.
Represents a rectangular area with borders that can contain child objects.
Initializes a new instance of the class.
For internal use.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the collection of child report items.
Gets the object defining page break behavior
for the current rectangle.
Null (default) means no page break.
Gets or sets a value indicating whether all of the contents of the rectangle
should be kept together on one page if possible.
Gets or sets a value indicating that borders should not appear at
locations where the rectangle spans multiple pages.
Also causes repeated background images to continue rather than
restart after a page break.
Gets or sets the name of a report item contained directly within this
rectangle that is the target location for the Document Map label (if any).
Ignored if DocumentMapLabel is not present.
Represents as subreport.
Initializes a new instance of the class.
For internal use.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the full folder path (for example, “/salesreports/orderdetails”) or relative path
(for example, “orderdetails”) to a subreport on the same server.
Relative paths start in the same folder as the current report.
Cannot be an empty string (ignoring whitespace).
Gets the collection containing parameters to the subreport.
Gets or sets the message to display in the subreport (instead of the region layout)
when no rows of data are available in any data set which is used in the body of the subreport.
Note: Style information on the subreport applies to this text.
Gets or sets a value indicating that transactions in the subreport should be merged with
transactions in the parent report (into a single transaction for the entire report)
if the data sources use the same connection.
Gets or sets a value indicating that the entire subreport should be kept together on one page if possible.
Gets or sets a value indicating that the borders should not appear at locations where the subreport spans multiple pages.
Also causes repeated background images to continue rather than restart after a page break.
Represents a report item contained in a body, header or corner cell of a .
Copies properties from another to the current object.
The value of the property is copied by value,
i.e. a copy of the is created and assigned to that property
on the current object.
The source object to copy properties from.
Gets the object containing this object.
Gets the object containing this object.
Gets or sets the number of columns this cell spans.
Default: 1.Must be 1 for inside
unless all column groups are static between the spanned
cells and the common ancestor of those cells.
Ignored for inside .
Gets or sets the number of rows this cell spans.
Default: 1.Must be 1 for inside .
Ignored for inside .
Gets or sets the object within the current cell.
The Top, Left, Height and Width for this are ignored.
The position is taken to be 0, 0 and the size to be 100%, 100%.
Represents the contents of a corner cell in a .
The width of each column is equal to the width of the corresponding
row .
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the object containing this object.
Gets the object containing this object.
Gets the containing this object.
Gets the object containing the content of the cell.
Page breaks in this are ignored.
Must be omitted if the position in the corner is covered by a span from
another cell. Required otherwise.
Represents the list of cells in a row of a corner section of a .
The height of the row is equal to the height of the corresponding
column .
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets the object containing this object.
Gets the object containing this object.
Gets the collection containing this object.
Gets or sets the at the specified index.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets object containing this object.
Gets object containing this object.
Gets object containing this object.
Gets or sets the at the specified index.
Represents the layout and structure of a corner region of a .
Copies properties from another to the current object.
The source object to copy properties from.
Gets the object containing this object.
Gets the object containing this object.
Gets the collection containing the list of rows in the corner section of the .
There must be as many elements as there are unique total heights
(sum of sizes of tablix headers of the member and all ancestor members)
of in the tablix column hierarchy.
Represents a column in the body section of a .
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the collection containing this object.
Gets or sets the width of each cell in this column.
Represents the set of columns in the body section of a .
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets object containing this object.
Gets or sets the at the specified index.
Represents a row in the body section of a .
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the object containing this object.
Gets the object containing this object.
Gets the collection containing this object.
Gets or sets the height of each cell in this row.
Gets the collection containing
the list of cells in a row in the detail section of the .
Represents the set of rows in the body section of a .
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets the object containing this object.
Gets the object containing this object.
Gets the object containing this object.
Gets or sets the at the specified index.
Represents the contents of a cell in the body section of a .
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the object containing this object.
Gets the object containing this object.
Gets the object containing this object.
Gets the collection containing this object.
Gets the object representing content of the cell.
Page breaks in a are ignored if the
has any row headers, any dynamic column groups or more than one column.
Must be omitted if the position in the body is covered by a span from
another cell. Required otherwise.
Gets or sets the name to use for the cell element.
Gets or sets a value indicating whether the cell contents should
appear in a data rendering.
Represents a list of cells in a row of the body section of a .
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets the object containing this object.
Gets the object containing this object.
Gets the object containing this object.
Gets or sets the at the specified index.
Represents the layout and structure of the body of a .
Copies properties from another to the current object.
The source object to copy properties from.
Gets the object containing this object.
Gets the object containing this object.
Gets the collection defining
the list of columns in the body section of the .
Gets the collection defining
the list of rows in the body section of the .
Represents a header of a .
Copies properties from another to the current object.
The source object to copy properties from.
Gets the object containing this object.
Gets the object containing this object.
Gets the object containing this object.
Gets or sets the height (if this is a column member) or
width (if this is a row member) of the group header.
Gets the object representing content of the group header.
Note that page breaks in this are ignored.
Specifies the rules for keeping a tablix member together with another member.
Do not keep the with another member.
Keep the with the previous dynamic member.
Keep the with the following dynamic member.
Represents a member of a hierarchy.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the parent object or null.
Gets the collection owning this object.
Gets the object containing this object.
Gets the object containing this object.
Gets the object contaning this object.
Gets the object defining data grouping.
If this property is null, the current tablix member is a static member,
otherwise it is a dynamic member.
Not allowed if any ancestor group is a detail group.
Gets the collection containing
expressions by which to sort the group instances.
Not used if is null.
Gets the object that defines the header cell for the member.
Gets the collection containing submembers contained within this member.
Gets the collection with custom properties for this member.
Gets or sets a value indicating whether the whole tablix member (including its body cells)
should be displayed on the page even when the user scrolls part of the off the page.
Can be true only on the outermost members on the hierarchy (row or column)
of the .Members with FixedData=True must be contiguous with all other FixedData members on the hierarchy.Not allowed to be true if the has headers on the opposite
hierarchy (FixedRowHeaders or FixedColumnHeaders).Not allowed to be true on the leftmost column member if GroupsBeforeRowHeaders is set.Not allowed to be true on row members unless set on the first row member.Not allowed to be true if a corresponding body cell is part of a span and the
FixedData for a peer TablixMember corresponding to another cell in the spanned area is false.
Gets the visibility of the current tablix member.
If all instances of all submembers of a particular member instance are hidden,
that member instance is automatically hidden.
Gets or sets a value indicating whether this static member should be hidden if the contains no rows of data.
Ignored for dynamic members.
A member hidden in this way ignores visibility properties (including ToggleItem).
Gets or sets a value indicates whether this static member should be kept on the page (if possible) with the closest
non-hidden instance of the previous or following sibling dynamic member.
Each sibling member between this member and the target dynamic member must have the
same value for KeepWithGroup as this member. Must be None on column members,
dynamic members or members with dynamic descendants.
Gets or sets a value indicating whether this static member should be repeated on every page
on which at least one complete instance of the dynamic member referred to via KeepWithGroup or one of that
member’s descendents (excepting descendents with KeepWithGroup not equal to None) appears.
Ignored if is None.
Each peer member between this member and the target dynamic member must
have the same value for RepeatOnNewPage as this member. Must be False on column members.
Gets or sets the name to use for the data element for this member.
Must be a CLS-compliant identifier.
Gets or sets a value indicating whether the current member should appear in data rendering.
Gets or sets a value indicating whether the entire member should be kept together
on one page if possible.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets the object containing this object.
Gets the object containing this object.
Gets or sets the at the specified index.
Represents a hierarchy of members for a .
Copies properties from another to the current object.
The source object to copy properties from.
Gets the object owning this object.
Gets the object containing this object.
Gets the collection containing
an ordered list of members of a tablix hierarchy.
Specifies the overall direction of the tablix layout.
Dynamic tablix columns grow left-to-right (with headers on the left).
Dynamic tablix columns grow right-to-left (with headers on the right) and the order of peer groups is reversed.
Represents a flexible layout grid with nested
repeating column groups and row groups.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the object defining the region
that contains the elements of the upper left corner area of the tablix.
Gets the object defining
the bottom right region that contains the data elements of the tablix.
Gets the object defining
the hierarchy of column members for the tablix.
Gets the object defining
the hierarchy of row members for the tablix.
Gets or sets the overall direction of the tablix layout.
Gets or sets the number of instances of the leftmost outer column member
that should appear to the left of the row headers (right of the row headers for
RTL tablixes). Ignored if the leftmost outer column member is a static member.
Default: 0; Min: 0; Max: 2147483647.
Gets or sets a value indicating that column headers should be repeated on each page on which
a portion of the appears.
Gets or sets a value indicating that column headers should be repeated on each page on which
a portion of the appears.
Gets or sets a value indicating that column headers should be displayed on the page even
when the user scrolls part of the off the page.
Gets or sets a value indicating that row headers should be displayed on the page even when
the user scrolls part of the off the page.
Gets or sets a value indicating that borders should not appear at locations where the tablix
spans multiple pages. Also causes repeated background images to continue rather than
restart after a page break.
Gets or sets a value indicating that whole tablix (all repeated sections) should be kept
together on one page if possible.
Represents properties of a toggle image displayed as a part of a .
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets a value determining the initial state of the toggle image.
True means "expanded" (that is, a minus sign). False means "collapsed" (that is, a plus sign).
Represents properties of end-user sort control that is displayed as a part of a text box in the UI.
The control allows the user to select a sort direction (ascending, descending, none).
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the expression on which to sort.
Has the same restrictions as a Group Filter expression.
Aggregates used in SortExpression may only use scopes which
equal or contain the . Aggregates without an explicit
scope are not allowed in SortExpression if no is specified.
Gets or sets the name of the scope (data region or group)
in which to evaluate the .
If omitted, the expression will be evaluated and the sort will be performed
independently in each detail scope within the .
Must be a scope that is equal to or contained within the current scope.
If the has no current scope
(in other words, it is not contained in any data region), SortExpressionScope
must be equal to or contained within the .
Cannot be a detail scope (that is, a group with no group expressions).
The data set for SortExpressionScope must be the same
as the data set for the .
Sorting takes place within the group containing the SortExpressionScope.
For example: In a with a country group and a city group with
on each header and of the corresponding group,
the country sort will sort the country groups within the tablix and the city sort
will sort the city groups within each country group (without rearranging the country groups).
Gets or sets the name of the data region, group or data set to apply the sort to.
If omitted, the sort will apply to the instance of the current scope.
Must be the current scope, an ancestor scope, or a peer scope which is a data region.
Specifies modes of processing of a .
evaluates as an expression if starts with a "=".
Otherwise, treats the as a constant.
is evaluated as an expression.
is treated as a constant.
Specifies how markup should be processed.
No markup is processed. Any markup is assumed to be literal.
HTML markup appearing in the text is processed and displayed
in supporting rendering extensions.
Represents the value and formatting of a contiguous span of text.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the collection containing this object.
Gets the object containing this object.
Gets the object containing this object.
Gets or sets the label for the placeholder for this TextRun.
This name appears as the display placeholder in designer tools UI.
Gets or sets the constant or expression which is displayed at runtime for the .
Gets the object defining style properties for this .
Gets object defining the actions for this .
on are ignored if an action is defined on the
parent (even if the action resolves to NULL).
Gets or sets a textual tooltip label for the .
Gets or sets a value indicating how markup in text should be processed.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets object owning this collection.
Gets or sets the at the specified index.
Specifies the paragraph list style.
Indicates that this is not a list paragraph and that there
is no bullet/number for this paragraph.
Indicates that this is a list paragraph with numbering.
Indicates that this is a list paragraph with bullets.
Represents a paragraph of text in a ;
contains a collection of elements.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the collection containing this object.
Gets the object containing this object.
Gets the collection.
Gets or sets the indentation from the left edge of the , less left padding.
Default: 0tw.
Gets or sets the indentation from the right edge of the , less right padding.
Default: 0tw.
Gets or sets the first line indent or hanging line indent for the paragraph,
relative to left indent.
This property can be negative.
If positive, indents just the first line (first line indent).
If negative, indents all lines but the first (hanging indent).
Default: 0tw.
Gets the object that defines style properties for the paragraph.
Gets or sets a value indicating whether this paragraph is part of a list,
and identifies the numbering type.
Gets or sets the numbering style and/or indentation level.
Must be equal or greater than 0 and less or equal than 9.
For paragraphs with None,
this property serves to indent the paragraph.
When is Bulleted or Numbered,
it serves as indentation level and bullet/number style.
Default: 0.
Gets or sets the spacing before the paragraph. Cannot be negative.
Default: 0tw.
Gets or sets the spacing after the paragraph. Cannot be negative.
Default: 0tw.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets object owning this collection.
Gets or sets the at the specified index.
Represents a formatted text.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets a value indicating whether the textbox height can increase to accommodate the contents.
Gets or sets value indicating whether the textbox height can decrease to match the contents.
Gets or sets a value controlling whether the text should not be displayed when the value of the
expression associated with the report item is the same as the preceding visible instance.
The value of this property is the name of a containing group
(other than the current group) or data set over which to apply the hiding.
Each time a new instance of that group is encountered, the first visible instance of
this report item will not be hidden. Rows on a previous page are ignored for the purposes of hiding duplicates.
If the current textbox is in a cell, only the text will be omitted.
The text box will remain to provide background and border for the cell.
Outside of a tablix cell, the background and borders are omitted as well.
Ignored unless the text box contains only one .
Gets the object containing the initial state of a toggling image
should one be displayed as a part of the current textbox.
Gets the object containing properties of the end-user sort control which
should be displayed as a part of this text box in the UI.
Gets or sets a value indicating whether all values for the current textbox
value should render as an element or attribute.
Gets or sets a value indicating that all of the contents of the current textbox
should be kept together on one page if possible.
Gets the collection that represents the content of the current textbox.
Defines parameters to obtain a list of values or default values for a .
Copies properties from another to the current object.
The source object to copy properties from.
Gets value indicating whether DataSetReference object correctly initialized.
Gets or sets name of the to use.
Gets or sets the name of the field to use for the values/defaults
for the .
Gets or sets the name of the field to use for the value to display
to the user for the selection.
If not supplied or the returned value is null, the value in the is used.
Not used for .
Represents default value for the .
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets the object defining the query to
execute to obtain the default value(s) for the .
For single-value parameters, the default is the first value of the .
For multivalue parameters, the default is all values of the .
Gets the default values for the .
Defines possible values for a .
Initializes a new instance of the class.
Initializes a new instance of the class.
Value of property.
Value of property.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets possible value for the parameter.
For Boolean parameters, use “true” and “false”.
For DateTime parameters, use ISO 8601.
For Float parameters, use “.” as the optional decimal separator.
If the Value expression returns an array, each item in the array
is treated as a single value. The items in the array must not be arrays.
Gets or sets label for the value to display in the UI.
If not supplied, the is used as the label
(if is not supplied, Label is the empty string).
If the Value expression returns an array,
the Label expression must return an array with the same number of items. If the Value expression does not return an array, the Label expression must not return an array.
Collection of object.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
Represents the possible values for ,
for populating UI selection lists for users to select a parameter value.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets value indicating whether this object is not empty.
Gets the object defining
the query to execute to obtain a list of possible values for the parameter.
Gets the collection defining
hardcoded values for the parameter.
Contains information about a parameter that is passed to the data source
as part of the query.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets containing this parameter.
Gets collection containing this object.
Gets or sets the data type of the .
Gets or sets value indicating the value for this parameter can be Null.
Cannot be true if this is a multivalue parameter.
Gets object defining default value for this
object.
Gets or sets value indicating the value for this parameter can be
the empty string. Ignored if is not String.
Gets or sets the user prompt to display when asking
for parameter values.
Gets or sets value indicating the parameter should not be
displayed to the user
(however, it will still be available for programmatic
use with subreports, drillthrough reports etc.)
Gets collection defining
possible values for the parameter (for the end-user UI).
Gets or sets value indicating this is a multivalue parameter
(a parameter that can take a set of values).
Multivalue parameters are accessed in expressions as zero-based arrays
in the Value and Label properties
(for example, Parameters!Cities.Value(0) and Parameters!Cities.Label(0)).
Ignored for Boolean parameters.
Gets or sets value indicating whether the parameter is used in a query
in the report.
This is necessary to determine if the queries must be rerun if the
parameter changes.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Finds a parameter with the specified name.
The name of the parameter to find.
with the specified name.
Gets object containing this object.
Gets or sets the at the specified index.
For internal use.
Sum.
Average.
Max.
Min.
Count.
Count distinct.
Standard deviation.
Standard deviation for entire population.
Variance.
Variance for entire population.
First.
Last.
For internal use.
Simple.
Recursive.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use only.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use only.
For internal use.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
Represents an exception that occurs when user scripts try to access a property
that is inaccessible in the current context.
Initializes a new instance of PropertyInaccessible class.
The name of the property that caused the error to occur.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Specifies sorting order.
Ascending sort.
Descending sort.
Represents an expression used to sort groups by.
Initializes a new instance of the class.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets the sort direction.
Gets or sets the value to sort by.
RunningValue and RowNumber functions are not allowed in .References to objects are not allowed.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
Specifies the border style.
Default. Treated as within and as elsewhere.
Do not draw a border.
Dotted line.
Dashed line.
Solid line.
Double solid line.
Dash-dot line. Allowed only within .
Dash-dot-dot line. Allowed only within .
Specifies the type of background gradient.
Default. Treated as .
No gradient.
Horizontal gradient.
Vertical gradient.
Circular gradient.
Diagonal left-to-right gradient.
Diagonal right-to-left gradient.
Center-out horizontal gradient.
Center-out vertical gradient.
Specifies the source of an image.
Source of an image is a file or a URL.
Source of an image is an embedded image.
Source of an image is a database field.
Specifies how a background image should fill the available space.
Treated as within and as elsewhere.
Repeat the image both horizontally and vertically to fill the available space.
Repeat the image horizontally to fill the available space. Not allowed within .
Repeat the image horizontally to fill the available space. Not allowed within .
Stretch the image to fill the available space. Allowed only within .
Clip the image to the available space.
Represent a border of an object.
Copies properties from another to the current object.
The source object to copy properties from.
Clears the current object, sets all properties to their default values.
Gets or sets the border's color.
Default: Black.
Gets or sets the border's style.
Default: .
Gets or sets the borders' width.
Default: 1pt.
Specifies the position of a background image.
Default. Treated as .
Draw image at top center.
Draw image at top left.
Draw image at top right.
Draw image at left center
Draw image in center.
Draw image at right center.
Draw image at bottom right.
Draw image at bottom center.
Draw image at bottom left.
Represents a background image.
Copies properties from another to the current object.
The source object to copy properties from.
Clears the current object, sets all properties to their default values.
Gets or sets the image source.
-
External
The property contains a constant or expression that evaluates to the location of the image. This can be a full folder path (for example, “/images/logo.gif”), relative path (for example, “logo.gif”) or URL (for example, “http://reportserver/images/logo.gif”). Relative paths start in the same folder as the report.
-
Embedded
The property contains a constant or expression that evaluates to the name of an in the report.
-
Database
The property contains an expression (a field in the database) that evaluates to the binary data for the image.
Gets or sets a value specifying the image.
That value is interpreted depending on the property.
Gets or sets the MIMEType for the image.
This property is required if is .
Otherwise this property is ignored.
Gets or sets a value indicating how the background image should fill the available space.
is treated as within
and as elsewhere
(unless another default behavior is specified in the definition of the containing element).
Gets or sets the color to treat as transparent in the background image.
Used only for background images within .
Gets or sets the position of the background image with
set to .
Used only for background images within .
Specifies font styles.
Default. Treated as .
Non-Italic font.
Italic font.
Specifies the thickness of the font.
Default. Treated as .
Matches CSS font weight 100.
Matches CSS font weight 200.
Matches CSS font weight 300.
Matches CSS font weight 400.
Matches CSS font weight 500.
Matches CSS font weight 600.
Matches CSS font weight 700.
Matches CSS font weight 800.
Matches CSS font weight 900.
Specifies special text formatting.
Default. Treated as .
No text decoration.
Underline the text.
Overline the text.
Strike through the text.
Specifies horizontal text alignment.
Default. Treated as .
Text alignment is derived from the data type and Direction.
Left aligned text.
Centered text.
Right aligned text.
Specifies vertical text alignment.
Default. Treated as .
Top aligned text.
Vertically centered text.
Bottom aligned text.
Specifies text direction.
Default. Treated as .
Left-to-right text.
Right-to-left text.
Specifies horizontal or vertical text direction.
Default. Treated as .
Horizontal text.
Vertical text – for East Asian text, characters are not rotated.
For other text, the entire text is rotated 90 degrees.
Specifies the calendar to use for formatting dates.
Default. Uses the .NET Framework default calendar for the language of the report item.
Gregorian.
Gregorian Arabic.
Gregorian Middle East French.
Gregorian Transliterated English.
Gregorian Transliterated French.
Gregorian US English.
Hebrew.
Hijri.
Japanese.
Korean.
Taiwan.
ThaiBuddhist.
Specifies effects to apply to the text.
Default. Treated as .
No special effect applied.
Shadow the text.
Emboss the text.
Apply embedding effect to the text.
Add a frame around the text.
Specifies background hatch type.
Default. Treated as .
No background hatching.
Backward diagonal hatching.
Cross hatching.
Dark downward diagonal hatching.
Dark horizontal hatching.
Dark upward diagonal hatching.
Dark vertical hatching.
Dashed downward hatching.
Dashed horizontal hatching.
Dashed upward diagonal hatching.
Dashed vertical hatching.
Diagonal brick hatching.
Diagonal cross hatching.
Divot hatching.
Dotted diamond hatching.
Dotted grid hatching.
Forward diagonal hatching.
Horizontal hatching.
Horizontal brick hatching.
Large checker board hatching.
Large confetti hatching.
Large grid hatching.
Light downward diagonal hatching.
Light horizontal hatching.
Light upward diagonal hatching.
Light vertical hatching.
Narrow horizontal hatching.
Narrow vertical hatching.
Outlined diamond hatching.
5 percent hatching.
10 percent hatching.
20 percent hatching.
25 percent hatching.
30 percent hatching.
40 percent hatching.
50 percent hatching.
60 percent hatching.
70 percent hatching.
75 percent hatching.
80 percent hatching.
90 percent hatching.
Plaid hatching.
Shingle hatching.
Small checker board hatching.
Small confetti hatching.
Small grid hatching.
Solid diamond hatching.
Sphere hatching.
Trellis hatching.
Vertical hatching.
Wave hatching.
Weave hatching.
Wide downward diagonal hatching.
Wide upward diagonal hatching.
Zig zag hatching.
Represents the style of a report item.
Initializes a new instance of the class.
The owner of the current style.
Copies properties from another to the current object.
The source object to copy properties from.
Clears the current object, sets all properties to their default values.
Gets the owner of the current style.
Gets the object specifying default border properties.
Gets the object specifying left border properties.
Gets the object specifying top border properties.
Gets the object specifying right border properties.
Gets the object specifying bottom border properties.
Gets or sets the background color.
Default: Transparent.
Gets or sets the background gradient type.
Default: Default.
Gets or sets the end color for the background gradient.
Gets the background image.
Gets or sets the font style.
Gets or sets the font family.
Gets or sets the font size.
Gets or sets the thickness of the font.
Gets or sets the format string used to format value of objects like TextBox etc.
Format represents a .NET Framework formatting string.
Note: Locale-dependent currency formatting (format code "C") is based on
the language setting for the .
Locale-dependent date formatting is supported and should be based on the
property of the .
Gets or sets the special text formatting.
Gets or sets the horizontal text alignment.
Gets or sets the vertical text alignment.
Gets or sets the foreground color.
Default: Black.
Gets or sets the padding between the left edge of the object and its contents.
Default: 0 pt. Max: 1000 pt.
Gets or sets the padding between the top edge of the object and its contents.
Default: 0 pt. Max: 1000 pt.
Gets or sets the padding between the right edge of the object and its contents.
Default: 0 pt. Max: 1000 pt.
Gets or sets the padding between the bottom edge of the object and its contents.
Default: 0 pt. Max: 1000 pt.
Gets or sets the height of a line of text.
Default: null, renderer determines line height based on font size.
Min: 1 pt. Max: 1000 pt.
Gets or sets a value indicating whether text is written left-to-right or right-to-left.
Does not affect the text alignment unless alignment is used.
Gets or sets a value indicating whether text is written horizontally or vertically.
Gets or sets the primary language of the text.
Default is null in which case the property of the will be used.
Gets or sets the calendar used for formatting dates.
Must be compatible with the .NET Framework Language setting.
Gets or sets the digit format to use as described by its primary language.
Any language is valid.
Default is null in which case the property will be used.
Gets or sets the variant of the digit format to use.
The valid values are from 1 (default) to 7.
See remarks for details.
-
1
Default, follow Unicode context rules
-
2
0123456789
-
3
traditional digits for the script as defined in GDI+. Currently supported for: ar | bn | bo | fa | gu | hi | kn | kok | lo | mr | ms | or | pa | sa | ta | te | th | ur and variants.
-
4
ko, ja, zh-CHS, zh-CHT only
-
5
ko, ja, zh-CHS, zh-CHT only
-
6
ko, ja, zh-CHS, zh-CHT only [Wide versions of regular digits]
-
7
ko only
Gets or sets the effect to apply to the text.
Gets or sets the hatch type.
If this property is set to a value other than ,
the property is ignored.
Gets or sets the color of the shadow for the item.
Default: #0000007F.
Gets or sets the size of the shadow for the item.
Default: 0.
Defines a named expression to be evaluated within the group or report.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets expression to evaluate globally for the report or for each
group instance.
Unlike expressions evaluated in visual elements of the report,
each instance of this expression is calculated only once when
the report is executed and never recalculated during subsequent renderings.
This is necessary for time-dependent calculations.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Gets or sets the at the specified index.
Defines when the should be shown in the rendered report.
Copies properties from another to the current object.
The source object to copy properties from.
Gets or sets value indicates if the item should be hidden at first.
Gets or sets the name of the text box used to hide/unhide this report item.
Clicking on an instance of the ToggleItem will toggle the hidden state of every corresponding instance of this item.
If the ToggleItem becomes hidden (because either the item or an ancestor is
toggled or conditionally hidden), this item should become hidden.
Must be a text box in the same group scope as this item or
in any containing (ancestor) group scope. If omitted, no item will
toggle the hidden state of this item.
Not allowed on and cannot refer to report items contained in a page header
or footer.
Cannot refer to a report item contained in the current report item unless
current group scope has a Parent.
Defines supported RDL versions.
RDL format is unknown.
RDL 2008 format.
RDL 2010 format.
Enumerates units of measurement used in a ,
used by and related types.
Specifies centimetre's as the unit of measure.
Specifies the millimeter as the unit of measure.
Specifies the inch as the unit of measure.
Specifies a printer's point (1/72 inch) as the unit of measure.
Represents a linear size of a report item or part.
Initializes a new instance of the type.
The string representation of the size.
An exception is thrown if does not represent a valid size.
Initializes a new instance of the type.
The size unit used by .
The size value, in units.
Gets the hash code for the current object, based on its value.
The hash code.
Compares the current size with another object.
This method performs comparison by value.
The object to compare the current with.
true if the two objects repesent the same size, false otherwise.
Converts the current object to a string.
The returned string can be converted back to the current length object
(e.g. it can be used to initialize a to the same value).
The string representing the current length value.
Converts the current size to centimeters.
The value of the current size in centimeters.
Converts the current size to inches.
The value of the current size in inches.
Converts the current size to millimeters.
The value of the current size in millimeters.
Converts the current size to points.
The value of the current size in points.
Converts the current size to "doc" units (1/300 of an inch).
The value of the current size in doc units.
Converts the current size to a .
The converted value.
Converts the current size to pixels.
The target resolution (pixels per inch).
The value of the current size in pixels.
Converts the current size to specified units.
The target units.
The converted value, in
Converts the current size to specified units.
The target units.
The converted value, in
Tests whether a size is null or empty.
The size to test.
true if is null or empty, false otherwise.
Compares two sizes.
The first size to compare.
The second size to compare.
-1 if is less than ,
1 if is greater than ,
or 0 if the two sizes are equal.
Converts a value to a string representation as in
the following table:
- Inch"in"
- Millimeter"mm"
- Point"pt"
- Centemeters"cm"
A to convert.
The string representing .
Converts a string to a value. The string can be one of the following:
"in", "mm", "cm", "pt".
This method is case-insensitive.
The string to convert.
OUT: On exit, contains the value.
true if no error occurred, false otherwise.
Converts a value to the corresponding value.
The value to convert.
The corresponding value.
Converts a string to the corresponding value.
A return value indicates whether the conversion succeeded or failed.
A string to convert.
OUT: a value specifying the units of the parsed size.
OUT: a double value representing the parsed size, in units.
true if was converted successfully; otherwise, false.
Converts a string to the corresponding value.
A string to convert.
A representing the size specified by .
Tests whether two values are equal.
The first size.
The second size.
true if the two sizes are equal, false otherwise.
Tests whether two values are not equal.
The first size.
The second size.
true if the two size are not equal, false otherwise.
Adds two sizes.
The first size to add.
The second size to add.
A size representing the sum of and .
Subtracts one size from another.
The size to subtract from.
The size that is subtracted.
A size representing the difference between and .
Gets the units of measurement used by the current size.
Gets the absolute value of the current size (in ).
Gets a value indicating whether the current size is negative.
Converts the current size to its absolute value.
The absolute value of the current size.
Represents an empty size.
For internal use.
For internal use.
For internal use.
Specifies the type of a value (e.g. in a ).
The value is Boolean.
The value is DateTime.
The value is Integer.
The value is Float.
The value is String.
Specifies a value that can be a Boolean true or false,
or have the value automatically determined depending on the current context.
The value is determined automatically depending on the current context.
The value is equivalent to a Boolean true.
The value is equivalent to a Boolean false.
Specifies operators used to compare data in filters, etc.
Equality comparison.
Like comparison. Uses the same special characters as the Visual Basic
LIKE operator (for example “?” to represent a single character and “*” to
represent any series of characters).
Inequality comparison.
Greater than comparison.
Greater than, or equal comparison.
Less than comparison.
Less than, or equal comparison.
Check if value is in top N values.
Check if value is in bottom N values.
Check if value is in top N percent values.
Check if value is in bottom N percent values.
Check if value is equal to any value.
Check if value is between the two values.
The abstract base class for types such as ,
, , ,
and others that allow to specify a value
either as a literal or as an expression.
A flag indicating that the value is an expression.
The expression.
Compares the current with another object.
This method performs comparison by value.
The object to compare the current with.
true if the two objects repesent the same value, false otherwise.
Gets the hash code for the current .
The hash value is calculated based on the current object's value.
The hash code.
Gets a value indicating whether the current is specified as an expression.
Gets the expression associated with the current .
Note that this property throws an exception if the current object contains a constant
(i.e. if gets false).
Represents a color value that can be specified as a System.Drawing.Color literal
or as an expression.
Initializes a new instance of the class with a literal color value.
A System.Drawing.ColorSystem.Drawing.Color value.
Initializes a new instance of the class with an expression or a literal color value.
A string used to initialize the new instance.
If this string starts with an equal sign ('=') it is interpreted as an exprssion.Otherwise, this string is converted to a System.Drawing.Color value
(an exception is thrown if that conversion fails).
Parses a string into properties of type.
A string to parse.
OUT: true if represents an expression, false otherwise.
OUT: if is false.
OUT: expression if is true.
true if s represents a valid instance.
Tests whether the two objects are equal.
The first object.
The second object.
true if the objects are equal, false otherwise.
Tests whether the two objects are not equal.
The first object.
The second object.
true if the objects are not equal, false otherwise.
Converts the current object to a string.
The string representing the current value.
Compares the current length with another object.
This method performs comparison by value.
The object to compare the current with.
true if the two objects repesent the same length, false otherwise.
Gets the hash code for the current object,
based on the length value.
The hash code.
Gets the System.Drawing.Color value represented by the current object if it contains a literal.
If the current object contains an expression, exception is thrown.
Static class holding a few predefined values.
The empty literal color.
The transparent literal color.
The black literal color.
The white literal color.
For internal use.
For internal use.
For internal use.
Represents an enum value that can be specified as a literal or as an expression.
Initializes a new instance of the class with a constant value.
A constant value.
Initializes a new instance of the class with an expression or a constant.
A string used to initialize the new instance.
If this string starts with an equal sign ('=') it is interpreted as an exprssion.Otherwise, this string is converted to the T type.
Parses a string into properties of type.
A string to parse.
OUT: true if represents an expression, false otherwise.
OUT: The enum value if is false.
OUT: expression if is true.
true if s represents a valid instance.
Tests whether two objects are equal.
The first object.
The second object.
true if the objects are equal, false otherwise.
Tests whether the two objects are not equal.
The first object.
The second object.
true if the objects are not equal, false otherwise.
Converts the current object to a string.
The string representing the current object.
Compares the current object to another object.
This method performs comparison by value.
The object to compare the current with.
true if the two objects repesent the same value, false otherwise.
Gets the hash code for the current object based on its value.
The hash code.
Gets the enum value if this object contains a constant,
throws an exception if this object contains an expression.
For internal use.
For internal use.
For internal use.
Represents a that can be specified as a constant or as an expression.
Initializes a new instance of the class with a constant value.
Unit of measurement used by .
Value, specified in units.
Initializes a new instance of the class with a value.
The constant.
Initializes a new instance of the class with as constant or expression specified as a string.
If this string starts with a '=' it is interpreted as an expression,
otherwise that string is converted to a constant value.
Parses a string into properties of type.
A string to parse.
OUT: true if contains an expression, false otherwise.
OUT: an instance of if is false, null otherwise.
OUT: the expression string if is true, null otherwise.
Returns true if represents a valid instance.
Tests whether two objects are equal.
The first object.
The second object.
true if the objects are equal, false otherwise.
Tests whether two objects are not equal.
The first object.
The second object.
true if the objects are not equal, false otherwise.
Converts the current object to a string.
The string representing the current value.
Compares the current object with another object.
This method performs comparison by value.
The object to compare the current with.
true if the two objects repesent the same value, false otherwise.
Gets the hash code for the current object based on its value.
The hash code.
Gets the value when this object contains a constant.
Throws an exception is thrown if this object contains an expression.
For internal use.
For internal use.
For internal use.
Represents a string that can be specified as a constant or as an expression.
Represents an empty object.
Initializes a new instance of the class.
This overload explicitly specifies whether the string is a constant or an expression.
A string.
A flag indicating whether should be interpreted as an expression.
Initializes a new instance of the class.
This overload parses the string to find out whether it is a constant or an expression.
If this string starts with a '=' then it is interpreted as an expression,
otherwise as a constant.
Indicates wthether the specified instance is null or empty.
The object to check.
true if is null or represents the value.
Parses a string into properties of the class.
The string to parse.
OUT: true if represents an expression.
OUT: the string value.
Tests whether two objects are equal.
The first object.
The second object.
true if the objects are equal, false otherwise.
Tests whether two objects are not equal.
The first object.
The second object.
true if the objects are not equal, false otherwise.
Converts the current object to a string.
The string representing the current object.
Compares the current object with another object.
This method performs comparison by value.
The object to compare the current with.
true if the two objects repesent the same value, false otherwise.
Gets the hash code for the current object, based on value.
The hash code.
Gets the constant value represented by the current object.
Throws an exception if the current object contains an expression.
For internal use.
For internal use.
For internal use.
Represents an integer that can be specified as a constant or as an expression.
Initializes a new instance of the class with a constant value.
The integer value.
Initializes a new instance of the class.
The string is parsed to determine whether it represents a constant or an expression.
If starts with a '=' then it is interpreted as an expression,
otherwise it is converted to an integer.
Parses a string into properties of the class.
The string to parse.
OUT: true if contains an expression.
OUT: the constant value if is false.
OUT: the expression if is true.
true if represents a valid , false otherwise.
Tests whether two objects are equal.
The first object.
The second object.
true if the objects are equal, false otherwise.
Tests whether two objects are not equal.
The first object.
The second object.
true if the objects are not equal, false otherwise.
Converts the current object to a string.
The string representing the current object.
Compares the current object with another object.
This method performs comparison by value.
The object to compare the current with.
true if the two objects repesent the same value, false otherwise.
Gets the hash code for the current object, based on value.
The hash code.
Gets the integer value of the current object if it contains a constant.
Throws an exception if it contains an expression.
Gets an object representing the zero (0) value.
For internal use.
For internal use.
For internal use.
Represents a Boolean value specified as a constant or as an expression.
Initializes a new instance of the class with a constant value.
The constant Boolean value.
Initializes a new instance of the class.
The string is parsed to determine whether it represents a constant or an expression.
If starts with a '=' then it is interpreted as an expression,
otherwise it is converted to a Boolean.
Parses a string into properties of the class.
A string to parse.
OUT: true if contains an expression, false otherwise.
OUT: the Boolean value if is false.
OUT: the expression if is true.
true if represents a valid , false otherwise.
Tests whether two objects are equal.
The first object.
The second object.
true if the objects are equal, false otherwise.
Tests whether two objects are not equal.
The first object.
The second object.
true if the objects are not equal, false otherwise.
Converts the current object to a string.
The string representing the current object.
Compares the current object with another object.
This method performs comparison by value.
The object to compare the current with.
true if the two objects repesent the same value, false otherwise.
Gets the hash code for the current object based on its value.
The hash code.
Gets the Boolean value if the current object contains a constant.
Throws an exception if it contains an expression.
Gets an object representing the constant false value.
Gets an object representing the constant true value.
For internal use.
For internal use.
For internal use.
Represents an object that can be specified either as a constant
or as an expression.
Represents an empty object.
Initializes a new instance of the class with a constant.
The object constant.
Initializes a new instance of the class.
The string is parsed to determine whether it represents a constant or an expression.
If starts with a '=' then it is interpreted as an expression,
otherwise as a constant string.
Tests whether an is null or empty.
The object to test.
trueif is null or empty, false otherwise.
Parses a string into properties of the class.
The string to parse.
OUT: true if string represents an expression, false otherwise.
OUT: the object (string) if is false.
OUT: the expression if is true.
Tests whether two objects are equal.
The first object.
The second object.
true if the objects are equal, false otherwise.
Tests whether two objects are not equal.
The first object.
The second object.
true if the objects are not equal, false otherwise.
Converts the current object to a string.
The string representing the current object.
Compares the current object with another object.
This method performs comparison by value.
The object to compare the current with.
true if the two objects repesent the same value, false otherwise.
Gets the hash code for the current object based on value.
The hash code.
Returns true if object contains null value.
Gets the object value if the current object contains a constant.
Throws an exception if the current object contains an expression.
For internal use.
For internal use.
For internal use.
Represents a float value that can be specified either as a constant
or as an expression.
Initializes a new instance of the class with a constant value.
The double constant.
Initializes a new instance of the class.
The string is parsed to determine whether it represents a constant or an expression.
If starts with a '=' then it is interpreted as an expression,
otherwise it is converted to a double value.
Parses a string into properties of the class.
The string to parse.
OUT: true if contains an expression, false otherwise.
OUT: the double value if is false.
OUT: the expression if is true.
true if represents a valid , false otherwise.
Tests whether two objects are equal.
The first object.
The second object.
true if the objects are equal, false otherwise.
Tests whether two objects are not equal.
The first object.
The second object.
true if the objects are not equal, false otherwise.
Converts the current object to a string.
The string representing the current object.
Compares the current object with another object.
This method performs comparison by value.
The object to compare the current with.
true if the two objects repesent the same value, false otherwise.
Gets the hash code for the current object, based on value.
The hash code.
Gets the double value when the current object contains a constant.
Throws an exception when it contains an expression.
Gets an object representing the zero value.
Gets an object representing the double.NaN value.
For internal use.
For internal use.
For internal use.
Defines a value that can be represented as expression or constant.
Initializes a new instance of the class.
Initializes a new instance of the class.
Value of property.
Copies properties from another to the current object.
The source object to copy properties from.
Gets object containing this object.
Gets or sets the value of this object.
Converts to/from other types.
Converts a string to a .
An that provides a format context.
The string to convert.
A representing .
Converts an object to a string.
An that provides a format context.
The object to convert.
The converted string.
Represents a collection of objects.
Initializes a new instance of the class.
Gets the type of collection elements.
The type.
Adds the specified to the current collection.
The object to add.
The index of the newly added object in the current collection.
Inserts the specified into the current collection.
The index where to insert the object.
The object to insert.
Adds the specified to the current collection.
The object to add.
The index of the newly added object in the current collection.
Gets or sets the at the specified index.
Represents information about a errors
that occurred during generation of a .
Initializes a new instance of the class.
The human-readable problem description.
The object that triggered the problem.
Gets the detailed description of the problem.
Gets the object which triggered the error.
Represents a collection of objects.
This is the type of the property
on a .
Adds a object to the current collection.
The warning to add.
The index of the added object in the current collection.
Gets or sets the element at the specified index.
The index in the current collection.
The element at the specified index.
Specifies the direction of the barcode
The barcode is rendered in the horizontal direction.
The barcode is rendered from the bottom up.
The barcode is rendered from the top down.
Represents a barcode in a .
Initializes a new instance of the class.
Initializes a new instance of the class.
The barcode encoding type.
For internal use.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Gets or sets the type of encoding to use when generating the barcode.
Note that BarCodeType.None is not a valid value for this property.
The selected encoding is applied to the value stored in the
property to generate the barcode image
displayed in the object.
The following sample shows how to use the BarCodeType property to encode
the value "123456" as a Code39-encoded barcode:
RenderBarCode rbc = new RenderBarCode();
rbc.BarCodeType = BarCodeType.Code39;
rbc.Text = "123456";
doc.Body.Children.Add(rbc);
Gets or sets a value indicating whether the string represending the property
should be displayed along with the barcode image.
By default, the object will show only the barcode image. To include a textual
representation of the value in the property, set this
property to true.
Gets or sets the value that is encoded as the barcode image.
Some encodings support alphanumeric values of any length. Others
are limited to numeric values or to a specific set of characters.
See the enumeration
for details.
If you use characters that are invalid for the current encoding, the
object will display a blank image.
The following sample shows how to use the Text property to encode
the value "123456" as a Code39-encoded barcode:
RenderBarCode rbc = new RenderBarCode();
rbc.BarCodeType = BarCodeType.Code39;
rbc.Text = "123456";
doc.Body.Children.Add(rbc);
Gets or sets the direction of the barcode. Obsolete, use Style.TextAngle instead.
Represents a fragment of a object.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Gets the which produced the current fragment.
Represents a fragment of a in a resolved .
Represents a fragment of a in a resolved .
The abstract base class for and .
Gets the geometric area of the character with the specified index.
The index of the character in the current fragment.
A structure representing the bounds of the specified character
relative to the content area of the object (without spacing, borders, padding).
The returned value may be if the text is rotated
(use the method in that case instead).
Gets an array of four points defining the (possibly rotated)
geometric area of the character with the specified index.
The index of the character in the current fragment.
An array of four structures representing the
corners of the specified character's area,
relative to the content area of the object (without spacing, borders, padding).
Unlike the method, this method works for rotated text as well.
Gets an array of bounding rectangles for a range of characters
(in the returned array, each line in the specified range
is represented by a separate structure).
The index of the first character in the range in the current fragment.
The number of characters in the range.
(If a number greater than the number of characters in the fragment is specified, no error is generated
and all characters are included in the range.)
An array of structures, each structure
corresponding to a line of text.
Gets a bounding for a range of characters.
The region is relative to the top left corner of the fragment's inner area.
The index of the first character in the range in the current fragment.
The number of characters in the range.
The bounding region for the specified range, or null if the range is invalid.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets a rectangle corresponding to a in the current fragment.
The anchor to test.
OUT: A structure defining the area within the current fragment
associated with .
OUT: true if is visible in the current fragment, false otherwise.
Adds information about all hyperlinks that appear in the current fragment
to a .
The collection of objects
to which data about hyperlinks within the current fragment will be added.
Gets the that produced the current fragment.
Adds information about all hyperlinks that appear in the current fragment
to a .
The collection of objects
to which data about hyperlinks within the current fragment will be added.
Searches for a object in the current fragment at the specified position.
Specifies a point within the current fragment relative to the top left corner of the fragment.
A object describing the found , or null if none was found.
Gets the that produced the current fragment.
Gets the that produced the current fragment.
Represents a fragment of a in a resolved .
Represents a fragment of a in a resolved .
Adds information about all hyperlinks that appear in the current fragment
to a .
The collection of objects
to which data about hyperlinks within the current fragment will be added.
Searches for a object in the current fragment at the specified position.
Specifies a point within the current fragment relative to the top left corner of the fragment.
A object describing the found , or null if none was found.
Gets the that produced the current fragment.
Gets the that produced the current fragment.
Determines how a
is positioned with respect to its containing
when the section grows or shrinks.
Use members of this enumeration to set the value of the
property in the class.
The field does not move. The space between the top of the field
and the top of the section remains the same.
The field moves vertically. The space between the bottom of the field
and the bottom of the section remains the same.
The field grows or shrinks with the section.
Both the distance from the top of the field to the top of the section,
and the distance from the bottom of the field to the bottom of the section,
remain the same.
Represents a field of a .
Objects of this type are created when a C1Report definition
is imported into a using the
.
This class can be also used when a C1Report field-like behavior is desired.
Initializes a new instance of the class.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Gets the original object that produced the current object
during data binding, or null if there is no such object.
Gets the collection of objects
describing text tab positions in the current object.
This property always returns a non-null collection,
initializing it if it has not been initialized yet.
Use to test whether there are any defined tab positions
without initializing .
Gets a value indicating whether the collection
has been initialized and contains at least one element.
Gets or sets the text of the current object.
This property contains the text that will be rendered on the document.
Depending on the value of the property,
this text may be rendered literally (as is, without any translation),
or as a script expression.
Gets or sets a picture to display in the current field.
This property may be set to one of the following three kinds of objects:
- A regular .NET object.
- A string containing an image file name or URL.
- A string containing the name of an image field in the data source.
The first two options are used to create unbound images, such as logos. These images do not
depend on the document data.
The third option is used to create bound images, such as product or employee pictures. These
images are stored with the document data.
If the current field's property is true,
this property gets or sets a value indicating whether
Uniform Resource Locators (URLs) will be automatically formatted
when found in the text.
Gets or sets a value indicating whether the
property should be interpreted as a literal value
or as a calculated expression.
If this property is set to false, the value of the property is
inserted in the document without any further processing.
If this property is set to true, the value of the property is
evaluated as a script expression and the result of the expression is
inserted in the document.
Gets or sets a value indicating whether
duplicate values in consecutive records should be suppressed.
You can use the property to hide a field in a document
when its value is the same as in the preceding record.
For example, in a report listing suppliers and their products, each supplier's name
can appear just once for each group of products, rather than repeat for each product.
Gets or sets a string used to format the value of the current field.
You can use this property to customize the way numbers, dates, times,
and text are displayed and printed.
For example, if you've created a Price field, you can set its
property to "Currency". If the field value is set to "4321.678", it would be rendered as $4,321.68.
You can use this property to format numbers (including currency and percentage
values), dates, boolean values, and strings.
The syntax for the format string is the same
as used with the .NET method.
Gets or sets a value indicating whether a line should be drawn across the current field.
The color, style, and thickness of the line are determined by the property.
Gets or sets a value indicating whether the current field should be displayed as a checkbox.
This property allows you to display boolean values graphically, rather than as plain text.
Gets or sets a value indicating whether the content of the property
on the current field should be interpreted as RTF.
Gets or sets the type of barcode displayed by the current field.
The default value () indicates that the current field
should not be rendered as a barcode.
Gets or sets a value indicating whether the text alignment in the current field
should depend on the type of data represented by the field. If this property
is true, numbers will align to the right while all other data to the left.
Gets or sets a value indicating whether the image should not be displayed,
works similar to .
Gets or sets a reference to a object to be rendered
as a sub-report within the current field.
Gets or sets a value indicating whether the height of the current field can increase
automatically to fit the field's content.
Gets or sets a value indicating whether the height of the current field can decrease
automatically to fit the field's content.
Gets or sets a value determining the vertical position of the current field
relative to the containing .
Normally, fields do not move when sections grow or shrink. In some cases, however, you may want
fields to grow with the section or to stay in the same position relative to the bottom of the
section.
This is especially common for fields used to create vertical lines that should extend
the entire height of the section.
Represents a fragment of a in a resolved .
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Gets the that produced the current fragment.
Represents temporary information used during a document's resolving.
An instance of this class is created for each that participates in resolving.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Represents splitting parameters of a .
For internal use only.
The base class for split parameters used when object should be split.
OUT (FindSplitPos):
The collection of SplitParams objects from children.
IN:
Specifies the requested split position.
IN:
Left / Top spacing.
IN:
Right / Bottom spacing.
IN:
Left / Top padding.
IN:
Right / Bottom padding.
IN:
Left / Top border.
IN:
Right / Bottom border.
IN:
Size of split dimension, on vertical split - height, on horizontal - width.
IN:
The content size of non split dimension,
on vertical split: Width - Inner.Left - Inner.Right;
on horizontal split: Height - Inner.Top - Inner.Bottom.
IN:
RepeatBordersVert or RepeatBordersHorz.
IN:
Indicates the type of split: vertical or horizontal.
IN:
ChildrenAlwaysCanSplitVert or ChildrenAlwaysCanSplitHorz, depends on
type of splitting: vertical or horizontal.
IN:
Gets SplitContext object containing some global options for splitting.
IN:
Indicates that the top parent object process the hard break.
OUT (FindSplitPos):
The size of new fragment, which is created at the split.
OUT (FindSplitPos):
Offsets for split position within content area,
the content area is split at position: RealSplitPos - ContentSplitOffset.
ContentSplitOffset calculated on the base
of padding / spacing / borders / RepeatBorders.
OUT (FindSplitPos):
The real split position within content area, calculated in the
FindVertSplitPosContent / FindHorzSplitPosContent.
ContentRealSplitPos = RealSplitPos - ContentSplitOffset.
Also see comments to ReprintedFooterSize.
OUT (FindSplitPos):
Offset of children' splitting position from ContentSplitPos.
OUT (FindSplitPos):
The size of reprinted footer at the bottom of object,
filled in the FindXXXContent method, after calling this method
the ContentRealSplitPos does not include this size, and real
RealSplitPos is:
ContentRealSplitPos + ContentSplitOffset + ReprintFooterSize.
OUT (FindSplitPos):
The size of reprinted header at the top of object which was split.
OUT (Split):
Indicates that after splitting the fragment which was split
must be reresolved. This field filled after RenderFragment.Split method.
OUT:
Indicates that all children splits at ONE line.
Initializes a new instance of the class.
Creates a copy of the current object.
The property is copied by reference.
Assigns (copies) properties from another to the current object.
The property is copied by reference.
The source object to copy properties from.
For internal use only.
For internal use only.
Indicates that the object has the splitted child objects.
For internal use.
For internal use.
For internal use.
Initializes a new instance of the class.
For internal use.
Specifies the logic for handling the CanGrow and CanShrink properties
of a C1Report's fields and sections in an imported report.
Use members of this enumeration to set the property
in the class.
Uses the standard C1Report mode, where fields that grow or shrink affect only fields directly below.
Uses a mode that is similar to MS Access, where fields that grow or shrink affect all fields below,
even if they are off to the side of the field that grew or shrank.
Represents a sub-report
(a C1Report contained within a
and specified by its property)
in a .
Initializes a new instance of the class.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Gets or sets a value indicating whether script objects should be exposed
to nested objects.
Gets or sets a script that is executed when data processing of the current object starts.
Gets or sets a script that is executed when data processing of the current object has completed.
Gets or sets a value indicating how and
properties are handled.
If this property is set to , fields with
or properties set to true will move fields directly
below them when they grow or shrink. Fields located below but off to the side are not moved.
If this property is set to , fields that grow or shrink will
affect all fields below, even those which are not directly under the field that was modified as a result of
CanGrow/CanShrink. (This is the Microsoft Access behavior.)
For example, if fields are arranged in a grid layout and is set to
, fields within each row will remain vertically aligned when fields
above them grow or shrink.
If is set to , fields within each
column will move independently of fields in other columns, and fields within each row will not remain vertically
aligned.
Represents a section of a .
Objects of this type are created when a C1Report definition
is imported into a using the
.
This class can be also used when a C1Report section-like behavior is desired.
Initializes a new instance of the class.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Gets or sets a value indicating whether the height of the current section can increase
automatically to fit the field's content.
Gets or sets a value indicating whether the height of the current section can decrease
automatically to fit the field's content.
Gets or sets a string containig the script to be executed before the current
section is formatted. This script is executed for each record, and can be used
to change the content of the section depending on the record data.
Gets or sets a string containig the script to be executed before the current
section is printed (after it has been formatted). This script can be used to
adjust the visual properties of the section which do not affect the layout
(e.g. text and background colors).
Represents a fragment of a in a resolved .
Represents a fragment of a in the generated document.
Gets the which produced the current fragment.
For internal use.
For internal use.
For internal use.
Gets the that produced the current fragment.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use.
For internal use only.
For internal use only.
For internal use only.
For internal use.
For internal use only.
For internal use only.
For internal use only.
For internal use.
For internal use only.
For internal use only.
For internal use only.
For internal use.
Defines the set of supported aggregate functions (see ).
Returns the sum of values of the expression within the scope.
Returns the average of values of the expression within the scope.
Returns the count of values of the expression within the scope.
Returns the minimum of values of the expression within the scope.
Returns the maximum of values of the expression within the scope.
Returns the count of distinct values of the expression within the scope.
Returns the first (in the sorted sequence)
value of the expression within the scope.
Returns the last (in the sorted sequence)
value of the expression within the scope.
Returns the variance of values of the expression within the scope.
Returns the population variance of values of the expression within the scope.
Returns the standard deviation of values of the expression within the scope.
Returns the population standard deviation of values of the expression within the scope.
Defines the scope of an .
The scope is the whole document.
The scope is the current group
as defined by .
Represents an aggregate value calculated on a data-bound element
of a over a certain scope.
Initializes a new instance of the class,
assigning the name of the aggregate.
A string assigned to the of this aggregate.
Initializes a new instance of the class,
assigning the name, expression, data binding, scope and function of the aggregate.
A string assigned to the property of this aggregate.
A string assigned to the property of this aggregate.
assigned to the property of this aggregate.
A value assigned to the property of this aggregate.
A value assigned to the property of this aggregate.
Sets the name of the current .
The new name of the aggregate.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets the containing the current aggregate.
Gets or sets the function (min, max, average and so on) calculated by the current aggregate.
The default value of this property is .
Gets or sets a value indicating whether null values should be ignored
when the current aggregate is calculated.
The default value of this property is true.
Gets the object used to calculate the value of the current aggregate.
Use the property to set the expression.
Gets or sets the text of the object used to calculate the value of the current aggregate.
The property can be used to get the object.
Gets or sets the data binding providing data over which the current aggregate is calculated.
Gets or sets a value determining the scope of the current aggregate:
whether it is calculated over all records, or separately for each group.
Gets the value of the current aggregate, calculating it if it has not been calculated yet
(the calculated value is cached).
Represents a collection of objects.
Initializes a new instance of the class.
The object that is the owner of this collection.
Adds an object to the current collection.
The object to add.
The index of the newly added object in the current collection.
Gets the object that is the owner of the current collection.
Enumerates aggregates by index.
Index of aggregate zero-based.
Returns the Aggregate object at specified position.
Gets the aggregate with the specified name.
The name of the aggregate.
The object with the specified ,
or an empty aggregate if an aggregate with the specified name was not found.
Specifies aggregates calculation mode.
Indicates that an aggregate should be calculated just over the specified datasource.
Indicates that an aggregate should be calculated recursively, i.e.
over all data in the current instance of the given scope, and over
all descendant instances of the current instance.
Represents the data binding properties of an databound element in a .
Properties of this type are on ,
and on groups of table rows and columns (see ).
Defines a method that allows to retrieve the value of a .
This interface is implemented by .
Returns the value of the specified object.
The whose value should be returned.
The value of .
Tests whether the property should be serialized.
True if the property should be serialized, false otherwise.
Tests whether the property should be serialized.
True if the property should be serialized, false otherwise.
Tests whether the property should be serialized.
True if the property should be serialized, false otherwise.
Tests whether the current data binding object is a parent (or a grand- or
a deeper-level parent) of another object.
The object that is tested for being a child of the current object.
true if the current object is a parent of the passed object, false otherwise.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets the name of the current .
That name can be used in aggregate functions to indicate which
data binding the aggregate refers to.
Gets or sets a string defining the used to generate
the outline caption for objects produced by the current data binding.
For instance, if a render object is data bound to a data source that contains a field
"CustomerName", setting this property to "Customer: [Fields!CustomerName.Value]"
will generate an outline node similar to "Customer: John Doe" for each generated
instance of the render object.
Gets or sets the parent outline node.
This allows to establish hierarchy of outline nodes for data-bound render object.
For instance, the following code:
C1PrintDocument doc = new C1PrintDocument();
RenderTable rtbl = new RenderTable();
doc.Body.Children.Add(rtbl);
doc.Outlines.Add(new OutlineNode("Document root", rtbl));
// set up data binding for rtbl.RowGroups[0,1]...
rtbl.RowGroups[0, 1].DataBinding.DataSource = myDataSource;
rtbl.RowGroups[0, 1].DataBinding.OutlineText = "Customer: [Fields!CustomerName.Value]";
rtbl.RowGroups[0, 1].DataBinding.ParentOutline = doc.Outlines[0];
will add outlines to the data-bound rows of 'rtbl', and will make
those outlines children of the 'Document root' outline node.
Gets the object which is the parent of the current data binding.
The parent is retrieved based on the objects' containment hierarchy.
For instance, for a RenderText within a RenderArea,
of the
on the RenderText will return DataBinding of the RenderArea
containing the text.
Gets the flags indicating the mode of the current data binding.
Gets a value indicating that the current data binding is not empty
and is linked to some data.
Gets or sets the data source associated with the current data binding.
Currently objects of the following types can be assigned to this property:
If the data source is an ,
that expression must evaluate to an instance of a
or a .
Gets the object that determines
how data retrieved by the current data binding is grouped.
Gets the object that determines
how data retrieved by the current data binding is sorted.
Gets the collection of data fields for the current data binding.
Gets the collection of expressions that are used to filter
the data retrieved by the current data binding.
Gets the object containing the current data binding.
Gets the current row or group instance number (see remarks).
This property should only be used while the document containing the current data binding
is generating. It then returns the number of the current data row.
When the document containing the current data binding is not generating,
or if processing of the object on which the current data binding is defined has not started yet,
this property returns 0.
When end of data has been reached during document generation,
this property returnst the last row number.
Represents a data schema of a .
This class contains:
- The list of data sources associated with the document
- The collection of data sources associated with the current document.
Each element in that collection determines how to connect to an external data source (connection string etc.).
- The collection of available data sets (tables, SQL queries).
- The collection of aggregates defined on the data.
Clears the current data schema, deletes all
associated data sets, data sources and aggregates.
Gets the containing the current data schema.
Gets the collection of objects
associated with the current data schema.
Those data sources are used to provide data for elements of the
collection.
Gets the collection of data sets provided by the current data schema.
A from this collection
can be assigned to the property
on of a ,
or on of a table row or column group ().
Gets the collection of named objects
defined on the current data schema.
The type of the data source.
This will determine the syntax of the ConnectionProperties.ConnectString and
Query.CommandText.
Microsoft SQL Server.
Microsoft OLE DB Provider.
Microsoft Open Database Connectivity Driver.
Oracle.
The XML file specified as the datasource, in this case
the ConnectString contains name of file.
Microsoft SQL Server Compact Edition driver version 3.5.
Microsoft SQL Server Compact Edition driver version 4.0.
Contains information about how to connect to a data source.
Copies properties from another ConnectionProperties object.
The source object, properties of which are copied.
Gets or sets the type of the data source.
This determines the syntax of the ConnectionProperties.ConnectString and
Query.CommandText.
Gets or sets the connection string for the data source.
Gets or sets the value indicating whether connection to this data source
should use integrated security.
For internal use only.
For internal use only.
For internal use only.
Represents a data set used by a data-bound element of a .
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the data source and the SQL query.
The object specifying the data source for this data set.
The text of an SQL query that will be executed to retrieve the data.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets the name of the current .
That name can be used in aggregate functions to indicate which
data set the aggregate refers to.
Gets the containing the current data set.
Gets the object for the current data set.
Gets the collection of objects describing fields
of the current data set. If this collection is empty, all fields fetched
by the query will be accessible on the data set.
Gets the collection of objects applied
to the fetched records to filter them for the current data set.
Gets or sets the expression used to filter which data rows are included
in the current data set.
This property is be assigned to the RowFilter property
of the underlying DataTable object.
Gets or sets the maximum number of records that will be fetched
from the data set. The default is -1, which includes all records.
Represents a collection of objects in a .
Initializes a new instance of the class.
The object containing this object.
Adds a object to the current collection.
The object to add.
The index of the added object in the current collection.
Finds the index of the object with the specified name in the collection.
The name to search for.
The index of the found object.
Searches for an dataset with the specified name in the current collection.
The name to search for.
The dataset with the specified name, or null if the dataset was not found.
Gets the containing the current data set collection.
Gets or sets the at the specified index.
The index in the current collection.
The at the specified index.
Gets the with the specified name.
The name of .
The with the specified name,
or null if the dataset could not be found.
Represents a field in a .
The field may represent a native DB field (assigned via the property),
or may be calculated by an expression (set by the property).
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the of this field.
A string assigned to the name used to identify this field.
If the current field is added to a ,
this name must be unique within that collection.
Initializes a new instance of the class,
assigning the and the associated DB field.
A string assigned to the name used to identify this field.
If the current field is added to a ,
this name must be unique within that collection.
The native DB name of this field.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets the used
to calculate the value of the current field.
If this expression is not empty, the field is
a calculated field (as opposed to a data field).
This property is never null (Nothing in VB), it always
returns an object,
which has empty
by default. (A non-empty Text string indicates a calculated field.)
To specify an expression, set its
property, or the property on the
current field.
Either this property or , but not both,
should be defined on a . In case both
properties are defined, is used, and
Expression is ignored.
Gets or sets the name of the corresponding DB field in the query.
If this property is not empty, the field is a data field (as opposed to a calculated field).
This name does not need to be unique within the containing collection,
and multiple s may refer to the same DB field.
Either this property or , but not both,
should be defined on a . In case both
properties are defined, this property is used,
and is ignored.
Gets or sets the text of the
used to calculate the value of the current field.
This is a shortcut to the
property on the expression returned by .
Represents a collection of objects.
All fields in the collection must have unique non-empty names.
Initializes a new instance of the class.
The object containing this .
Adds a object to the current collection.
The object to add.
The index of the added object in the current collection.
Gets the object containing the current collection.
Gets the element at the specified index.
The index in the current collection.
The element at the specified index.
Gets the field with the specified name.
The name of the field.
The object with the specified ,
or null if a field with the specified name was not found.
Represents a data source in a
or in a .
Initializes a new instance of the class.
Initializes a new instance of the class,
assigning the data source type and connection string.
A specifying the type of this data source.
The data source connection string.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets the containing the current data source.
Gets the containing the current data source.
Gets the object
containing data source connection information (connection string, data provider etc.).
Gets or sets a value indicating whether all data for all data sets that use the current data source
should be fetched within a single transaction.
The default value of this property is false.
Represents a collection of objects in a
(see ).
Initializes a new instance of the class.
The object containing this .
Adds a to the current collection.
The object to add.
The index of the added object in the current collection.
Gets the containing the current collection.
Gets or sets the at the specified index.
The index in the current collection.
The at the specified index.
For internal use.
Represents an expression that can be used is calculated fields, grouping, sorting etc.
The following classes use expressions:
Initializes a new instance of the class.
Initializes a new instance of the class.
A string to assign to the property.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Creates a copy of the current object.
The newly created object.
Gets or sets the text of the current .
If not set, an empty string is returned.
Represents a collection of objects.
Initializes a new instance of the class.
The owner of the current collection.
Creates an specified by its text,
and adds it to the current collection.
The text of the expression to add.
The index of the added in the current collection.
Adds an to the current collection.
The to add.
The index of the added in the current collection.
Gets or sets the element at the specified index.
The index in the current collection.
The element at the specified index.
Represents a data field available to a data-bound object of a .
The collection of available fields is returned by the
property of the object's .
If the of the
containing the current field is an ,
the represents a property available on the type of objects in the enumerated collection.
If the is a ,
the represents a
in that data set.
Initializes a new instance of the class.
Unique name of the field.
Sets the name of the current .
The new name of the field.
Copies properties from another object.
The source object, properties of which are copied.
Gets the object containing this object.
Gets the value of field.
Collection of Field objects.
Initializes a new instance of the class.
The owner of the current .
Called after the collection has been cleared.
Sets property to false.
Called after an item has been removed.
Sets property to false.
The item index.
The item.
Called after an item has been set.
Sets property to false.
The item index.
The old item.
The new item.
Called after an item has been inserted.
Sets property to false.
The item index.
The item.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Adds a new object to the current collection.
The object to add.
The index of the added object in the current collection.
Gets the owner of the current collection.
Gets a value indicating whether the current collection was created automatically
and was not changed by the user.
Gets the element at the specified index.
The index in the current collection.
The element at the specified index.
Gets the field with the specified name.
The name of the field.
The object with the specified ,
or an empty field if a field with the specified name was not found.
Represents a set of expressions that determine the grouping of data
in a data-bound object in a
(see ).
When the document generates, a new group is created
if at least one expression in the collection
evaluates to a different value.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets a value indicating whether the collection
contains at least one grouping .
Gets the object which is the owner of the current collection.
Gets the collection of expressions defining the data grouping.
When the document generates, a new group starts if at least
one expression in this collection evaluates to a different value.
Specifies the query type of a .
The of a
contains the SQL query text.
The of a
contains the name
of a stored procedure that should be executed to retrieve the data.
The of a
contains the name
of a data table.
Describes a query that is executed to fetch data for a
(the query is specified by the property
on the data set object).
Initializes a new instance of the class.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets the object
against which to execute the current query.
Gets or sets the type of query assigned to the property
on the current query.
Gets or sets the command text that is executed to obtain the data.
The interpretation of this text depends on the query type
specified by the property.
Gets or sets the number of seconds to allow the query to run
before timing out. Must be nonnegative. If
omitted or zero, the query should not time out.
The default value of this property is 0 (zero).
Gets the collection of objects that are passed
to the data source as part of the current query.
Represents a parameter that is passed to the data source
as part of a query defined by a object.
Initializes a new instance of the class,
assigning the parameter's name.
The unique name of this parameter.
Initializes a new instance of the class,
assigning the parameter's name and value.
The unique name of this parameter.
The value of this parameter.
Sets the name of the current .
The new name of the parameter.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets the collection containing the current object.
Gets or sets the value of the current parameter.
Represens a collection of objects.
All parameters in the collection must have unique non-empty names.
Initializes a new instance of the class.
The object which is the owner of the current collection.
Adds a object to the current collection.
The object to add.
The index of the added object in the current collection.
Gets the object containing the current collection.
Gets the element at the specified index.
The index in the current collection.
The element at the specified index.
Gets the parameter with the specified name.
The name of the parameter.
The object with the specified ,
or null if a parameter with the specified name was not found.
Represents the collection of sort expressions (see )
associated with a data-bound object in a .
This is the type of the proprty
of the class.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets a value indicating whether any sort expressions are defined on the current object.
This property returns true if the collection is not empty,
false otherwise.
Gets the collection of objects defined on the current object.
Defines the types of sorting.
Sorts in ascending order.
Sorts in descending order.
Represents an expression used to sort data, and the direction of the sort.
Initializes a new instance of the class.
Initializes a new instance of the class,
specifying the sort expression and direction.
The sort expression.
The sort direction.
Copies and properties from another object.
(Note that the property is not copied.)
The source object to copy properties from.
Creates a copy of the current object
(the property is not cloned).
The newly created object.
Gets the object defining the expression.
Gets or sets the sort direction.
Gets or sets the text of the sorting expression ().
Collection of SortExpression objects.
Initializes a new instance of the class.
The owner of the current collection.
Adds an ascending specified by the expression text
to the current collection.
The sort expression text.
The object that was created and added to the current collection.
Adds a specified by the expression text and sort direction
to the current collection.
The sort expression text.
The sort direction.
The object that was created and added to the current collection.
Adds a object to the current collection.
The object to add.
The index of the added object in the current collection.
Gets or sets the element at the specified index.
The index in the current collection.
The element at the specified index.
For internal use only.
The base class for design-time dropdown editors.
When overridden in a derived class, should return the type of used by the editor.
Returns the style of the current editor.
The editor context.
.
Edits the value.
The editor context.
The service provider.
The value to edit.
Gets false.
Represents a 's native C1DX format .
Tests whether the specified object represents a document that can be exported
by a .
The object (document) to test.
true if is an instance of
or , false otherwise.
Tests whether documents of the specified type can be exported
by a .
The type to test.
true if is
or , false otherwise.
Creates a new instance of .
The newly created instance.
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 1.
Gets a short description of the C1DX export format.
Gets the default filename extension for the current export format.
This implementation returns "c1dx".
Gets a value indicating whether export to stream is supported by the current format.
This implementation returns true (export to stream is supported).
Gets the type of form which is used to edit the export options by default.
Gets the combination of flags indicating which fields of the class
are supported by the current export format.
Represents an object that can be used to export a document to C1DX format.
Copies the properties of the current exporter to corresponding
user-editable options of the specified export options form.
The object to copy the properties to.
Overridden.
Gets a value that determines the format used to save the document.
This implementation returns .
Gets .
Represents a form for editing the export options used by an .
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Gets a value indicating whether the associated document contains outline entries.
Gets or sets the folder used to save image files.
Gets or sets the scaling factor.
Gets or sets a value indicating whether a separate HTML page should be generated
for each page of the source document.
Gets or sets a value indicating whether to generate page separator lines
Gets or sets a value indicating whether to generate the outline.
Gets or sets a value indicating whether to generate hyperlinks to individual pages.
Gets or sets the location of the generated hyperlinks.
Represents a form for editing the export options used by an .
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Represents a form that can be used to show printing or export progress.
Initializes a new instance of the class.
Performs export to a disk file, using a new instance of to show operation progress.
The exporter to use.
The output file name.
Performs export to a stream, using a new instance of to show operation progress.
The exporter to use.
The output stream.
Prints a document, using a new instance of to show operation progress.
The print manager to use.
The printer settings.
The default page settings.
Performs export to a disk file, using the current to show operation progress.
The exporter to use.
The output file name.
Performs export to a stream, using the current to show operation progress.
The exporter to use.
The output stream.
Prints a document, using the current to show operation progress.
The print manager to use.
The printer settings.
The default page settings.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Contains data describing an outline entry extracted from a metafile
comment record created by C1Report or compatible (using the "%PDFHdr|" prefix).
Creates a new instance of EmfOutlineHeader class.
0-based page index.
Outline level.
Entry text.
Entry rectangle.
Gets or sets the 0-based page index.
Gets or sets the entry outline level.
Gets or sets the entry text.
Gets or sets the entry rectangle.
The .NET PreviewPrintController creates metafiles with gdi+ commands.
This is bad for us because the format of such emf records is not
documented, and so we can not e.g. search for text. But, if we just
use .NET PrintController, the page generation process slows down by
a factor of 2 (at least). The only way to avoid this is to inherit
from PreviewPrintController but provide our own graphics, based on
emf-only metafiles. Another caveat is which base methods to call and
which not. Invoking base.OnStartPrint/base.OnEndPrint is necessary
because if we do not do that performance is the same as with the
regular PrintController (i.e. bad). OTOH, invoking base.OnStartPage/
base.OnEndPage looks like wasting time (as we can not use the provided
graphics anyway) and what is more, for big documents at some point
seems to drain resources and causes our creation of metailes to fail.
So what is below seems to be the only combination that works. Still,
the whole printing stuff in .NET is a mess. --dima.
For internal use only.
Represents the design-time editor for objects.
Gets the type of the control ().
For internal use only.
Represents a design-time editor for the class.
Gets the type of editor control.
The type.
The abstract base class describing an export format
that performs export by iterating over the list of metafiles representing pages of a document.
Tests whether the specified object represents a document that can be exported
by the associated .
The object (document) to test.
true if is an instance of
, ,
, or a collection of objects,
and false otherwise.
Tests whether documents of the specified type can be exported by the current export provider.
Note that if the type is array, this method returns false even though an array of metafiles
can be exported by the associated exporter. Use to get a definitive value.
The type to test.
true if is
or , false otherwise.
The abstract base class for all exporter classes associated with export providers
derived from .
Non-abstract classes derived from this class must override
the method.
Initializes a new instance of the class.
Copies the properties of the current exporter to corresponding
user-editable options of the specified export options form.
The object to copy the properties to.
Copies the options from the specified export options form
to corresponding properties on the current exporter.
The object to copy the options from.
Gets or sets a value indicating whether the document should be saved in Office12 Open XML format.
true if document should be exported in Office12 format, false otherwise.
Gets or sets a value indicating whether the exported document
should preserve the pagination of the original document.
true if pagination should be preserved, false otherwise.
Gets or sets a value indicating whether the exported document
should exactly match the appearance of the original document.
Usually this can only be achieved at the cost of preserving
the logical structure and/or ease of editing of the exported document.
true if exact appearance should be preserved, false otherwise.
Represents a form for editing the export options used by an .
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Gets or sets a value indicating whether EmfPlus metafiles should be converted to EmfOnly.
Represents a form for editing the export options used by an .
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Gets or sets a value indicating whether to use compression.
Gets or sets a value indicating whether to embed embeddable fonts used in the document.
Gets or sets the owner password.
Gets or sets the user password.
Gets or sets the type of encryption to use for a password-protected PDF document.
Gets or sets a value indicating whether the resulting document can be printed.
Gets or sets a value indicating whether the content of the resulting document can be copied.
Gets or sets a value indicating whether the content of the resulting document can be edited.
Gets or sets a value indicating whether the annotations in the resulting document can be edited.
Gets or sets a value indicating whether input fields in the original document
should be exported as Acrobat form fields.
Gets or sets viewer preferences.
Gets the associated exporter.
Describes export to HTML.
Tests whether the specified object represents a document that can be exported
by a .
The object (document) to test.
true if is an instance of
or , false otherwise.
Tests whether documents of the specified type can be exported by the current export provider.
The type to test.
true if is
or , false otherwise.
Creates a new instance of .
The newly created instance.
Tests whether
can handle the specified type of document pages' range.
This implementation returns true.
The type of range to test.
true.
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 40.
Gets a short description of the HTML export format.
Gets the default filename extension for the current export format.
This implementation returns "htm".
Gets a value indicating whether export to stream is supported by the current format.
This implementation returns false (export to stream is not supported).
Gets a value indicating whether the associated
can show a dialog allowing the user to edit the export options.
This implementation returns true.
Gets the type of form which is used to edit export options by default.
This implementation returns type.
Represents an object that can be used to export a object to HTML.
Initializes a new instance of the class.
Copies the properties of the current exporter to corresponding
user-editable options of the specified export options form.
The object to copy the properties to.
Copies the options from the specified export options form
to corresponding properties on the current exporter.
The object to copy the options from.
Not supported for this class.
Resets the internal state of the exporter.
Resets the internal state of the exporter and all its public properties.
Performs export to a disk file.
If has not been set, this method returns immediately.
Gets or sets the path name of the folder where images are to be saved.
Gets or sets a value indicating whether to create a frame containing the document's outline.
Gets or sets a value indicating whether to export each page
of the document into a separate file.
Gets or sets a value indicating whether to generate hyperlinks to individual pages.
Note that this only works if is also true.
Gets or sets a value indicating whether to delimit individual pages
of the original document with horizontal lines.
Gets or sets the location of hyperlinks on the generated page(s)
(the hyperlinks can contain outline entries or page numbers).
Gets or sets the scaling factor applied to all elements
of the resulting HTML document, in percent.
Gets or sets a template used to create a navigation bar with page numbers.
(Note: both and must be set to true for this to work).
The format of the string is as follows:
up to four "%s" strings are replaced with links to the first, previous, next and last pages,
correspondingly.
Up to two "%d" strings are replaced with the current and total page numbers.
For instance:
"<a %s>first</a> <a %s>prev</a> Page %d of %d <a %s>next</a> <a %s>last</a>"
Gets or sets a value indicating whether export should
try to preserve the exact original height of all elements.
Generally, setting this property to false makes the resulting
HTML document more flexible.
Gets or sets the maximum number of page hyperlinks in a row.
Gets .
Defines the location of hyperlinks in the generated HTML pages.
Hyperlinks are not generated.
Hyperlinks are located at the top of pages.
Hyperlinks are located in the left frame.
Hyperlinks are located in the right frame.
Hyperlinks are located in the top frame.
Hyperlinks are located in the bottom frame.
Defines the hyperlink generation mode.
No hyperlinks are generated.
The generated hyperlinks are based on the document outline.
The generated hyperlinks point to individual pages.
Represents a that allows a user to edit
associated with a document.
Initializes a new instance of the class.
Copies the data from a object to properties of the current .
The to copy properties from.
Creates a new object, and copies data
from the current into that object.
The object containing data from the current form.
Creates a new form,
or form of a type derived from .
The custom form type (must be or derived from it).
The default form type (used if is null,
must be or derived from it).
The newly created form.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Gets or sets the combination of identifying fields supported by this form.
Represents a form that can be used to enter a range of pages.
Initializes a new instance of the class.
Assigns the output range.
The range to assign.
Builds an output range based on the input data.
The new range.
Creates an instance of the or derived type.
Custom form type or null.
Default form type.
The newly created .
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Gets or sets a value indicating whether the "allow all pages" option is available.
Gets or sets a value indicating whether the "page range" option is available.
Gets or sets a value indicating whether the "page list" option is available.
Gets or sets a value indicating whether the "inverted list" option is available.
Gets or sets the maximum page number.
Represents a position within a generated document
as a combination of the page index and the area on that page.
Initializes a new instance of the class.
The 0-based page index.
Initializes a new instance of the class.
The logical page number.
The 0-based page index.
The bounds on page (specified in ).
The units used to specify .
The resolution if is pixels.
Initializes a new instance of the class.
The target document page.
The target bounds on page.
Initializes a new instance of the class.
The target document page.
Initializes a new instance of the class.
The target location.
Clones the current .
The copy of the current document location.
Gets the target 0-based page index.
Gets the target logical page number.
Gets the bounds on the target page, in .
Units used by .
Unit resolution if is in pixels.
Represents a fragment of a in a resolved .
For internal use.
For internal use.
For internal use.
For internal use.
Gets the which produced the current fragment.
Represents an external object that can be seamlessly rendered in a .
See remarks for details.
The object that this class renders is specified by the value of the property.
For an object to be assignable to that property, it must expose either of the following two instance methods:
- Image C1PrintableGetImage()If this method is implemented, it should return an
representing the object to be rendered.
- Stream C1PrintableGetTree()If this method is implemented, it should return a
containing a serialized representing the object to be rendered.
For instance, such stream can be created using the method.
To implement a C1PrintableGetTree() method on a class, follow these steps:
-
Add a method
public Stream C1PrintableGetTree() to your class;
-
In that method's body, create a , and render a representation of your class
into the of that document, using the available render objects
such as , and so on.
-
At the end of that method, create a new object,
call the method to save your document to that memory stream,
and return it.
You will then be able to assign an instance of your class to the
property of a object, and insert that object anywhere
in a where a standard render object may occur.
Initializes a new instance of the class.
Initializes a new instance of the class,
and assigns the property.
The object to assign to the property.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Gets the default flags for this type.
Gets the default value for the property.
False.
Gets a representing the "C1PrintableGetTree" method.
or null.
Gets a representing the "C1PrintableGetImage" method.
or null.
Assigns (copies) properties from another to the current object.
Calls the base method.
If is a , also copies -specific properties.
The source object to copy properties from.
Indicates whether the property should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the elements of the collection should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Indicates whether the property should be copied.
Forces the generation of inner render object or objects representing the
object being printed (specified by the property).
The generated render objects can be accessed via .
Removes the inner render object or objects representing the object being printed.
Gets or sets the object to render.
The object must implement either a
Image C1PrintableGetImage() or a Stream C1PrintableGetTree()
method accessible via reflection.
For details, see the remarks section in .
Gets or sets a value indicating whether the page layout
specified on the document returned by the Stream C1PrintableGetTree() method
should be ignored.
Represents a fragment of a .
Gets the which produced the current fragment.
Represents a fragment of a in a resolved .
Gets the that produced the current fragment.
Gets the containing the current fragment.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use.
For internal use.
For internal use.
For internal use only.
For internal use.
For internal use.
For internal use.
Enumerates the languages which can be used in scripts
(see ).
VB.NET is used as the scripting language.
Native C1Report scripting language is used.
C# is used as the scripting language.
Represents the various options controlling scripts and expressions
used in a , and specified
by the property.
Scripts and expressions can be used in various contexts in a .
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 ,
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:
- Text expressions
In expressions specified in square brackets in texts of
, or objects,
the following context-dependent identifiers can be used:
Id (type)Meaning- Document ()The current document.
- RenderObject ()The current render object.
- RenderFragment ()The current render fragment.
- Page ()The current page.
- PageNo ()The current 1-based page number.
- PageCount ()The total page count.
- PageX ()The current 1-based horizontal page number.
- PageXCount ()The maximum horizontal page count.
- PageY ()The current 1-based vertical (regular) page number.
- PageYCount ()The total vertical page count.
- Aggregates ()The list of aggregates defined on the current document.
- DataBinding ()The active databinding (may differ from the
value of the property on the current
render object, e.g. if it is not defined and parent's databinding is being used).
- Fields ()A shortcut to on the active databinding.
- RowNumber ()A shortcut to on the active databinding.
(Note: while square brackets are the default for marking expressions in C1PrintDocument texts,
they can be redefined via the and
properties.). - expressions
In expressions used in any of
,
,
,
,
the following context-dependent identifiers are available:
Id (type)Meaning- Document ()The current document.
- DataBinding ()The current databinding.
- Fields ()The collection of the current databinding.
- Parent ()The parent databinding. Normally this is the most nested databinding defined
on a parent of the object containing the current databinding.
For a , 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).
- expression
In expressions used to specify calculated data set fields
(),
the following context-dependent identifiers are available:
Id (type)Meaning- Document ()The current document.
- Fields ()The collection of the current data set.
- Document scope scripts
In scripts assigned to
,
,
or
,
the following context-dependent identifiers are available:
Id (type)Meaning- Document ()The current document.
- Tags ()The collection of the current document
(this is a shortcut to Document.Tags).
- Render object scope scripts
In scripts assigned to
,
the following context-dependent identifiers are available:
Id (type)Meaning- Document ()The current document.
- RenderObject ()The current render object.
- Tags ()The collection of the current document
(this is a shortcut to Document.Tags).
- Render fragment scope scripts
In scripts assigned to
,
the following context-dependent identifiers are available:
Id (type)Meaning- Document ()The current document.
- RenderObject ()The current render object.
- RenderFragment ()The fragment that has resolved.
- Tags ()The collection of the current document
(this is a shortcut to Document.Tags).
Indicates whether the current object should be serialized.
true if the current object should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Indicates whether the property should be serialized.
true if should be serialized, false otherwise.
Resets the property to its default value.
Resets the property to its default value.
Resets all properties of the current object to their default values.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Initializes the current object witih the specified
external assemblies and namespaces.
An array of assembly names that are added to on the current object.
An array of namespace names that are added to on the current object.
Gets the list of external assemblies that can be used in scripts in the current document.
Gets the list of namespaces that can be used in scripts in the current document.
Gets or sets a value indicating which language is used in scripts attached to the document.
Represents a read-only collection of system tags
(objects derived from ).
Gets a in the current collection by its index.
The index of the in the current collection.
The with the specified index.
Gets a in the current collection by its .
The name of the .
The with the specified name.
Extends the design mode behavior of a .
Initializes the designer with the specified component.
The to associate the designer with.
This component must always be an instance of, or derive from, .
Gets the collection of associated with this designer.
Describes export to Adobe PDF format.
The abstract base class for export providers that perform export by iterating
over the list of metafiles representing the pages of a document.
Tests whether the specified object represents a document that can be exported by the current export provider.
The object (document) to test.
True if the object represents a document that can be exported, false otherwise.
Tests whether documents of the specified type can be exported by the current export provider.
Note that if the type is array, this method returns false even though an array of metafiles
can be exported by the associated exporter. Use to get a definitive value.
The type to test.
true if is
, or PrintDocument, false otherwise.
Tests whether the specified type of range can be exported by the current export provider.
The to test.
True if the specified range can be exported, false otherwise.
Creates a new instance of the class.
The newly created .
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 10.
Gets a short description of the PDF export format.
Gets the default filename extension for the current export format.
This implementation returns "pdf".
Gets a value indicating whether export to stream is supported by the current format.
This implementation returns true (export to stream is supported).
Gets a value indicating whether the associated
can show a dialog allowing the user to edit the export options.
This implementation returns true.
Gets the type of form which is used to edit export options by default.
This implementation returns type.
Gets the combination of flags indicating which fields of the class
are supported by the current export format.
This implementation returns the combination of
Author,
Creator,
Producer,
Title,
Subject and
Keywords.
Represents security properties of a PDF document.
Initializes a new instance of the class.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets the type of encryption used when generating a password-protected PDF document.
Gets or sets the password required to open the PDF document.
Gets or sets the password required to change permissions for the PDF document.
Gets or sets a value indicating whether the user can print the PDF document.
Gets or sets a value indicating whether the user can copy contents of the PDF document.
Gets or sets a value indicating whether the user can edit the contents of the PDF document.
Gets or sets whether the user can edit annotations in the PDF document.
Specifies the type of encryption to use for a password-protected PDF document.
40-bit RC4 encryption.
128-bit RC4 encryption.
128-bit AES encryption.
Specifies the page layout to be used when a PDF document is opened.
Do not specify a layout and use the current viewer default.
Display one page at a time.
Display the pages in one column.
Display the pages in two columns, with odd-numbered pages on the left.
Display the pages in two columns, with odd-numbered pages on the right.
Specifies how a PDF document should be displayed when opened.
Document outline visible if available.
Neither document outline nor thumbnail images visible.
Document outline visible.
Thumbnail images visible.
Full-screen mode, with no menu bar, window controls, or any other window visible.
Represents viewer preferences to be used when displaying a PDF document.
Initializes a new instance of the class.
Creates a copy of the current object.
The newly created object.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets or sets a value indicating how the PDF document should be displayed when opened.
Gets or sets the page layout to be used when the PDF document is opened.
Gets or sets a value indicating whether to hide the viewer toolbars when the PDF document is active.
Gets or sets a value indicating whether to hide the viewer menu bar when the PDF document is active.
Gets or sets a value indicating whether to resize the PDF document's window to fit the size of the first displayed page.
Gets or sets a value indicating whether to position the PDF document's window in the center of the screen.
Represents an object that can be used to export a document to PDF.
Base class for all exporters working over list of pages.
Derived classes must override ProcessPage method.
Initializes a new instance of the class.
Exports a page of a document represented by a .
The representing the page to export.
The containing information about the .
The 1-based page number.
true if represents the first page of the document, false otherwise.
Performs export to a disk file or to a stream.
The destination (file or stream) is determined by which of the properties
( or ) is non-null
when this method executes.
Copies the properties of the current exporter to corresponding
user-editable options of the specified export options form.
The object to copy the properties to.
Copies the options from the specified export options form
to corresponding properties on the current exporter.
The object to copy the options from.
Gets .
Gets or sets a value indicating whether to use compression in the produced PDF document.
The default is true.
Gets or sets a value indicating whether to embed TrueType fonts used in the source document, in the produced PDF document.
The default is true.
Gets or sets a value indicating whether to export input fields as Acrobat Form fields.
The default is true.
Gets the object describing security properties of the produced PDF document.
Gets the object describing viewer preferences to be used
when the produced PDF document is opened.
Gets or sets the type of form that is used to edit the
associated with the PDF documents that is exported.
The form type must be or derived from it.
That form is invoked from the export options form.
Gets or sets a value indicating whether EMF+ metafiles should be parsed directly without
converting them to EMF-only first.
The default is false. Set to true if you have issues resulting from EMF+ to EMF conversion.
Specifies the type of content in a document exported to Excel.
The type of content is determined automatically.
The document mostly contains text.
The document mostly contains tables.
Describes export to XLS format.
Creates a new instance of the class.
The newly created .
Indicates whether the associated exporter
can handle the specified type of document pages' range.
This implementation returns true (all types of ranges are supported).
The type of range to test.
true if the associated can handle the specified output range, false otherwise.
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 21.
Gets a short description of the XLS export format.
Gets the default filename extension for the current export format.
This implementation returns "xls".
Gets the combination of flags indicating which fields of the class
are supported by the current export format.
This implementation returns Author.
Gets a value indicating whether export to stream is supported by the current format.
This implementation returns true (export to stream is supported).
Gets a value indicating whether the associated exporter
can show a dialog allowing the user to edit the export options.
This implementation returns true.
Gets the type of form which is used to edit export options by default.
This implementation returns type.
Describes export to XLSX (Open XML) format.
Creates a new instance of the class,
and sets the property on that instance to true.
The newly created .
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 20.
Gets a short description of the XLSX export format.
Gets the default filename extension for the current export format.
This implementation returns "xlsx".
Gets the type of form which is used to edit export options by default.
This implementation returns type.
Represents an object that can be used to export a document to Excel (XLS and XLSX) formats.
Initializes a new instance of the class.
Copies the properties of the current exporter to corresponding
user-editable options of the specified export options form.
The object to copy the properties to.
Copies the options from the specified export options form
to corresponding properties on the current exporter.
The object to copy the options from.
Exports a page of a document represented by a .
The representing the page to export.
The containing information about the .
The 1-based page number.
true if represents the first page of the document, false otherwise.
Resets the internal state of the exporter.
Resets the internal state of the exporter and all its public properties.
Gets or sets the amount (in points) by which to change font sizes
(may be used to better fit texts into available space).
Gets or sets a value indicating whether to export each page
of the document into a separate sheet.
Gets or sets a value indicating the Excel book content.
Gets or sets a value indicating whether the export module should
try to auto detect the type of data (numeric, date) in the cells.
Gets or sets the tolerance (in points) when auto-detecting the
boundaries of rows and columns in the document. The smaller this
amount, the greater the number of narrow rows and columns created
for precise positioning of data.
The tolerance value.
Gets or sets a value indicating whether only data should be exported,
ignoring visual attributes.
Gets or sets a value indicating whether EMF+ metafiles should be parsed directly without
converting them to EMF-only first.
The default is false. Set to true if you have issues resulting from EMF+ to EMF conversion.
Depending on the value of the property on the current exporter,
gets or .
Represents a form used to show a warning.
Initializes a new instance of the class.
Shows a warning.
The warning text.
The registry key that can be used to disable future warnings of this kind.
Tests whether warnings of a certain kind are disabled.
The registry key identifying warnings of the kind to test.
true if specified warnings are disabled, false otherwise.
Clean up any resources being used.
Helper class containing additional information about a
(the list of pages and areas on those pages where that hyperlink occurs).
Initializes a new instance of the class.
The hyperlink with which the current object is associated.
The object where hyperlink points.
Gets the associated with the current object.
Gets the where hyperlink points, it can differ
from Hyperlink.LinkTarget if Linktarget contains calculated fields.
Gets value of property.
Gets or sets value of property.
Gets the containing the areas
occupied by the hyperlink on different objects.
Typically this collection would contain just one element, but can
contain more if the hyperlink is split between pages.
Describes the position of a hyperlink on a page.
Initializes a new instance of the class.
The 0-based index of the page.
The region on the page.
Initializes a new instance of the class.
The 0-based index of the page.
The rectangle on the page.
Initializes a new instance of the class.
The 0-based index of the page.
The rectangle on the page.
Destructs this instance.
Disposes the current object.
Gets the region of the current area.
Gets the page index of the current area.
Collection of Area objects.
Adds an area to the current collection.
The area to add.
The index of the added area in the current collection.
Gets the element at the specified index.
The index in the collection.
The element at the specified index.
Helper class containing additional information about a within a document.
Initializes a new instance of the class.
The anchor associated with the current instance.
object defining abchor's position.
Initializes a new instance of the class.
The anchor associated with the current instance.
The 0-based page index.
The point on the page.
Initializes a new instance of the class.
The anchor associated with the current instance.
object where anchor is.
The bounds on the page.
Gets the associated with the current object.
Gets the 0-based index of the page containing the anchor.
Gets the position of the anchor on page.
Gets object defining position of anchor in document.
Describes a collection of objects.
Finds a at the specified position on the specified page.
The 0-based index of the page.
The position on the page.
associated with the found hyperlink, or null.
Adds a to the current collection.
The to add.
The index of the newly added object in the current collection.
Gets or sets the element at the specified index.
The index in the current collection.
The element at the specified index.
Describes a collection of objects.
Adds a to the current collection.
The to add.
The index of the newly added object in the current collection.
Searches by anchor's name.
Name of anchor.
object or null.
Gets or sets the element at the specified index.
The index in the current collection.
The element at the specified index.
For internal use only.
Provides methods to extract hyperlinks, anchors and outline entries from metafiles.
Extracts information about hyperlinks and anchors from a metafile.
The metafile to extract the info from.
The 0-based page index.
The collection of hyperlinks to fill.
The collection of anchors to fill.
The horizontal resolution.
The vertical resolution.
Extracts the list of outline headers from a metafile.
The metafile to extract the info from.
The 0-based page index.
The horizontal resolution.
The vertical resolution.
The of records.
Provides printing services.
Initializes a new instance of the class.
Tests whether an object can by printed by this print manager.
If this method returns false for an object, an attempt to assign that object
to will cause an exception.
Currently supported types include:
- PrintDocument
- IEnumerable (assumes a list of page images).
The document to test.
True if the document can be printed, false otherwise.
Prints the with the specified printer settings.
The to use, or null to use the defalt printer settings.
Prints the with the specified printer settings.
The to use, or null to use the defalt printer settings.
The default page settings to use (can be null).
Gets or sets the document that to print.
If the assigned value is an unsupported object, an exception will be thrown.
Use to verify that the object can be printed.
Gets or sets the object specifying the printing options.
Gets or sets the object specifying the pages to print.
Gets the printer name.
Occurs periodically when a long operation is in progress.
Can be used to provide progress indication and/or the ability for the user to cancel printing.
Occurs when an external exception is thrown (e.g. while printing).
Fired from within the event handler
of the current print manager, prior to actually printing the page.
Allows to adjust the hard margins of the printer (e.g. to compensate
for a buggy printer driver, see ),
or to print the current page in user code (see ).
See also .
Describes arguments for the event,
fired from within 's
event handler. Allows the user to adjust hard printer margins (e.g. to compensate
for a buggy printer driver), or to print the page in user code
(in that case, should be set to true
by the event handler).
Creates a new instance of .
Creates a new instance of .
The print manager that is printing the document.
The current page image (usually a ).
The printable area (in hundredths of an inch).
The current .
Gets the print manager object that is printing the document.
Gets the current page image (usually this is a ).
Gets the object passed into the PrintPage
event handler of the print manager.
Gets or sets the physical printable area of the printer, in hundredths of an inch.
When the event is fired, this property contains the printable area of the printer
as returned by the printer driver, rotated if landscape printing.
You may want to adjust this property e.g. to compensate for a buggy printer driver
reporting incorrect hard margins.
Gets or sets a value indicating whether the event hanlder has printed the
page, or whether the caller (print manager) should print the page as usual.
The default is false.
Represents a method that can handle a event.
The source of the event.
A that contains event data.
Describes options controlling how a document's content
is to be printed (or previewed).
Occurs when a property on the current object changes.
Gets or sets a value indicating whether the paper source is selected automatically.
The default value is false.
Gets or sets the value indicating the manner in which pages are scaled during printing.
The default value is .
Gets or sets a value indicating whether the page should be centered on paper during printing.
The default value is true.
Gets or sets a value indicating whether pages should be auto-rotated to better fit the paper during printing.
The default value is true.
Gets or sets a value indicating whether page metafiles should be converted to
bitmaps and clipped to printer's hard margins prior to printing.
The default value is false.
Normally document pages are sent to printer as metafiles.
If a page exceeds the printable area of a printer, problems may occur
with some printer drivers when the page is printed.
In those cases set this property to true.
Gets or sets a value indicating whether a line is drawn around the printable area of the page.
This may be useful for diagnostic purposes. is used to draw the line.
The default is false.
Gets or sets the pen used to draw printable area bounds if is true.
If this value is null (which is the default), a single-pixel black pen is used.
Gets or sets the type of metafiles used when printing standard .NET PrintDocument documents.
The default is EmfType.EmfPlusDual.
If your printer needs to scan the output for data (e.g. a fax number;
a case in point is Tobit Faxware) and fails, try setting this to EmfType.EmfOnly.
Note that this property ONLY affects printing of standard .NET PrintDocument documents,
and has no bearing on other supported document types.
Describes export to objects representing the pages of a document.
Creates a new instance of the class.
The newly created .
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 100.
Gets a short description of the EMF export format.
Gets the default filename extension for the current export format.
This implementation returns "emf".
Gets a value indicating whether export to stream is supported by the current format.
This implementation returns true (export to stream is supported).
Gets a value indicating whether the associated
can show a dialog allowing the user to edit the export options.
This implementation returns true.
Gets the type of form which is used to edit export options by default.
This implementation returns type.
Provides export of a document to a sequence of metafiles in disk files or in a stream.
EmfExporter supports export to stream in the following format:
-
int
The total page count.
-
int
The length of the first page data (bytes).
-
byte[]
The first page data.
-
int
The length of the second page data (bytes).
-
byte[]
The second page data.
-
...
...and so on for all pages...
Initializes a new instance of the class.
Exports a page of a document represented by a .
The representing the page to export.
The containing information about the .
The 1-based page number.
true if represents the first page of the document, false otherwise.
Indicates whether page metafiles of types and
should be converted to type before exporting.
The base implementation returns the value of property.
Copies the properties of the current exporter to corresponding
user-editable options of the specified export options form.
The object to copy the properties to.
Copies the options from the specified export options form
to corresponding properties on the current exporter.
The object to copy the options from.
Gets .
Gets or sets a value indicating whether
metafiles of types and
should be converted to type before exporting.
Represents the collection of registered export providers (classed derived from ).
Gets the index of the specified in the current collection.
The export provider to search for.
Index of the specified export provider in the current collection, or -1 if it was not found.
Registers an in the current .
The export provider to register.
Searches for an by its format key.
The format key is an arbitrary string that uniquely identifies
the export format. For each format, it is returned by the
property.
The format key string.
The , or null if none has been found.
Gets the at the specified index.
The index in the current collection.
The element at the specified index.
Gets the with the specified default file extension (see ).
The default file extension associated with the export format.
The that has the specified default extension, or null if no such provider exists in the current collection.
Gets the count of registered export providers in the current collection.
Gets the static collection of all registered objects.
Gets the static registered instance of the XLS export provider.
Gets the static registered instance of the XLSX export provider.
Gets the static registered instance of the DOCX export provider.
Gets the static registered instance of the RTF export provider.
Gets the static registered instance of the PDF export provider.
Gets the static registered instance of the EMF export provider.
Gets the static registered instance of the TIFF export provider.
Gets the static registered instance of the PNG export provider.
Gets the static registered instance of the JPEG export provider.
Gets the static registered instance of the GIF export provider.
Gets the static registered instance of the BMP export provider.
Gets the static registered instance of the HTML export provider.
Gets the static registered instance of the C1D export provider.
Gets the static registered instance of the C1DX export provider.
Gets the static registered instance of the C1DB export provider.
Gets the static registered instance of the C1MDX export provider.
Gets the static registered instance of drill-down HTML export provider for .
Gets the static registered instance of paged HTML export provider for .
Gets the static registered instance of HTML export provider for .
Gets the static registered instance of RTF export provider for .
Gets the static registered instance of field-based RTF export provider for .
Gets the static registered instance of plain text export provider for .
Gets the static registered instance of single page plain text export provider for .
Gets the static registered instance of compressed metafile export provider for .
Gets the static registered instance of Microsoft Excel export provider for .
Gets the static registered instance of the OpenXml Excel export provider for .
Provides static utility methods for export and printing.
Tests whether the page with the specified number exists in the document.
The physical page number (1-based index).
The list of page images or null.
The document or null.
True if the page exists, false otherwise.
Gets the page metafile for export or printing.
The physical page number (1-based index).
The pages collection (may be null).
The document (may be null).
The page metafile.
Gets the page metafile for export or printing.
The object supporting IC1Document.
The 0-based page index.
The page metafile.
Gets the page metafile for export or printing.
The C1PrintDocument object.
The 0-based page index.
The page metafile.
Gets the page metafile for export or printing.
The reference graphics for the metafile.
The physical page number (1-based index).
The pages collection (may be null).
The document (may be null).
The metafile.
Gets the list of page images representing the document, or null
if the document is a C1Preview.
The export document.
Out: the page count.
The list of page metafiles or null.
Returns the minimum page number for the specified document.
The target document.
The minimum page number valid for this document.
Gets the maximum valid physical page number (1-based index) for the specified document.
The target document.
The page count.
The maximum page number valid for this document.
Gets the maximum valid physical page number (1-based index) for the specified document.
The target document.
The maximum page number valid for this document.
Converts an array of 0-based physical page indices to an array
of 1-based logical page numbers.
The array of page indices.
The document.
The array of logical page numbers.
Converts a 0-based page index to the logical 1-based page number.
The 0-based page index.
The document object.
The logical 1-based page number.
The abstract base class for all image export providers.
Derived classes must override the method.
Gets the image format associated with the current export provider.
Must be overridden in a derived class to return a specific image format.
The image format associated with the current export provider.
Creates a new instance of ,
sets the property on that instance
to the image format returned by .
The newly created instance.
Gets a value indicating whether the associated
can show a dialog allowing the user to edit the export options.
This implementation returns true.
Gets the type of form which is used to edit export options by default.
This implementation returns type.
Gets the associated with the current export provider.
Gets the default filename extension for the current image export format.
Describes export to bitmaps representing the pages of a document.
Gets the image format associated with the current export provider.
This implementation returns .
The image format associated with the current export provider.
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 105.
Gets a short description of the bitmap export format.
Describes export to GIF files representing the pages of a document.
Gets the image format associated with the current export provider.
This implementation returns .
The image format associated with the current export provider.
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 104.
Gets a short description of the GIF export format.
Describes export to JPEG files representing the pages of a document.
Gets the image format associated with the current export provider.
This implementation returns .
The image format associated with the current export provider.
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 103.
Gets a short description of the JPEG export format.
Describes export to PNG files representing the pages of a document.
Gets the image format associated with the current export provider.
This implementation returns .
The image format associated with the current export provider.
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 102.
Gets a short description of the PNG export format.
Describes export to TIFF files representing the pages of a document.
Gets the image format associated with the current export provider.
This implementation returns .
The image format associated with the current export provider.
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 101.
Gets a short description of the TIFF export format.
Represents an object that can be used to export a document to a sequence of images.
Initializes a new instance of the class.
Sets the to the default value
(may be changed later).
Copies the properties of the current exporter to corresponding
user-editable options of the specified export options form.
The object to copy the properties to.
Exports a page of a document represented by a .
The representing the page to export.
The containing information about the .
The 1-based page number.
true if represents the first page of the document, false otherwise.
Gets the export provider associated with the current .
Depending on the current , returns one of the following:
Gets or sets the image format associated with the current exporter.
Supported formats are:
,
,
,
and
.
Gets or sets the resolution of the exported image.
Describes export to RTF format.
Creates a new instance of the class.
The newly created .
Indicates whether the associated exporter
can handle the specified type of document pages' range.
This implementation returns true (all types of ranges are supported).
The type of range to test.
true if the associated can handle the specified output range, false otherwise.
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 30.
Gets a short description of the RTF export format.
Gets the default filename extension for the current export format.
This implementation returns "rtf".
Gets the combination of flags indicating which fields of the class
are supported by the current export format.
This implementation returns the combination of
Author,
Creator,
Title,
Operator,
Subject,
Keywords,
CreationTime,
RevisionTime,
Manager,
Company and
Comment.
Gets a value indicating whether export to stream is supported by the current format.
This implementation returns true (export to stream is supported).
Gets a value indicating whether the associated exporter
can show a dialog allowing the user to edit the export options.
This implementation returns true.
Gets the type of form which is used to edit export options by default.
This implementation returns type.
Describes export to DOCX (Open XML) format.
Tests whether the specified object represents a document that can be exported
by a .
The object (document) to test.
true if is an instance of
or , false otherwise.
Tests whether documents of the specified type can be exported by the current export provider.
The type to test.
true if is
or , false otherwise.
Creates a new instance of the class,
and sets the property on that instance to true.
The newly created .
Specifies the preferred ordinal of the export format in "save as..." and similar dialogs.
This implementation returns 31.
Gets a short description of the DOCX export format.
Gets the default filename extension for the current export format.
This implementation returns "docx".
Gets the type of form which is used to edit export options by default.
This implementation returns type.
Represents an object that can be used to export a document to RTF and DOCX formats.
Initializes a new instance of the class.
Copies the properties of the current exporter to corresponding
user-editable options of the specified export options form.
The object to copy the properties to.
Copies the options from the specified export options form
to corresponding properties on the current exporter.
The object to copy the options from.
Exports a page of a document represented by a .
The representing the page to export.
The containing information about the .
The 1-based page number.
true if represents the first page of the document, false otherwise.
Resets the internal state of the exporter.
Resets the internal state of the exporter and all its public properties.
Performs export to a disk file or to a stream.
Gets or sets a value indicating whether to create drawing canvases in the resulting document.
Gets or sets a value indicating whether EMF+ metafiles should be parsed directly without
converting them to EMF-only first.
The default is false. Set to true if you have issues resulting from EMF+ to EMF conversion.
Depending on the value of the property on the current exporter,
gets or .
Provides data for page-related events such as
, ,
and .
Gets the associated with this event.
Represents a method that can handle page-related events such as
, ,
and .
The source of the event.
A that contains the event data.
Provides data for the event.
Gets or sets the associated with this event.
Represents a method that can handle the event.
The source of the event.
A that contains the event data.
Provides data for the event.
Initializes a new instance of the class.
Gets the object on which the value has changed.
Represents a method that can handle the event.
The source of the event.
A that contains the event data.
For internal use.
Specifies the type of an .
All pages of the document are in the range.
Pages that are in the range are specified as a list.
One or more ranges of pages are specified.
Describes a part of the document (pages or objects) that is to be
exported or printed.
Note: all page numbers are 1-based.
If included in the page indices list, specifies that all pages
from preceeding to the next one are to be included in the output.
This value indicates an invalid page number.
Creates a new instance of the output range that includes all pages in the document.
Note that enumerating the resulting range must be broken by the client.
Creates a new instance of the output range that includes all pages in the document.
The maximum page number (used to prevent infinite enumeration).
Creates an instance of OutputRange that includes a single interval of
pages. FromPage may be greater than ToPage, in that case the range is
inverted.
The number of the first page to include (1-based).
The number of the last page to include (1-based).
Creates an instance of OutputRange that includes all pages with
numbers specified in the list. The list may include Dash values to
specify intervals.
The array of page numbers to include.
Creates an instance of OutputRange that includes pages specified by the
string parameter.
The string may contain:
- page numbers (1-based) separated by spaces or commas;
- dashes ('-') to specify intervals (a dash at the end implies infinity).
The pages to be included.
Copies values from another instance of OutputRange.
The OutputRange to copy values from.
Clones the current OutputRange.
The newly created instance.
Returns a string that represents the current OutputRange.
A string that represents the range.
Returns the first page in the range.
The number of the first page.
Returns the page number in the range following the specified one, or
-1 if the specified number was the last one.
The current page number.
The next page number or -1 if there's none.
Returns the page number in the range following the specified one, or
-1 if the specified number was the last one.
The current page number.
A cookie used to avoid infinite loops in cases where the same page number appears in several ranges.
Set this value to 0 before the first call to this method.
The next page number or -1 if there's none.
Tests whether the specified page is within the range.
The page number to test.
True if the page is in the range, false otherwise.
Creates and returns a new enumerator that allows to loop
through all pages in the range.
The new enumerator.
Gets or sets the value indicating whether the range should be inverted.
If the range is inverted, the range's iterator goes from the end of the
range backwards.
True if the range is inverted, false otherwise.
Gets or sets the absolute upper limit for page numbers in the range.
The upper limit value.
Type of range: all pages, range of pages etc.
Gets the list of page numbers.
Gets the total number of pages in the range.
Note that if the MaxPageNumber has not been set, this
property will get int.MaxValue.
Gets the first page in the range.
Gets the last page in the range.
Represents an all-inclusive range.
Allows to enumerate all pages in the range.
Note: It is the client reesponsibility to take steps
to avoid infinite loops if the OutputRange
was created without specifying a valid MaxPageNumber.
Creates a new instance of the OutputRange enumerator.
Resets the enumerator.
Moves to the next page number in the range.
True if there are more pages in the range.
Gets the current page number.
The current page number.
Specifies the way pages are scaled during printing.
Pages are not scaled.
Pages are enlarged or made smaller if needed to fit paper.
Pages are made smaller if needed to fit paper.
For internal use only.
A static class providing printing-related utilities.
Calculates the page zoom factor and the location of the page (top/left)
inside the printer paper size, according to the specified page scaling
mode. All sizes should be in the same units.
Printer paper size.
Printable area (depends on the printer).
Landscape angle supported by the printer (90 or 270).
Document page size.
Page content rectangle (pageSize sans the margins).
Print options to use.
OUT: Page location relative to the paper top left.
OUT: Page zoom factor.
OUT: whether the page should be rotated
(the angle is opposite to landscapeAngle).
Layouts a resolved page of a .
The page to layout.
Target units.
Target X resolution.
Target Y resolution.
OUT: Page size.
OUT: Content rectangle.
Layouts a page represented by an .
The image of the page to layout.
The page settings to use.
Target units.
Target X resolution.
Target Y resolution.
OUT: Page size.
OUT: Content rectangle.
Tests whether a page should be rotated to better fit paper.
The paper size.
The page size.
true if the page should be rotated, false otherwise.
Rotates a paper size and the printable area within it by the specified angle.
The rotation angle, counterclockwise (valid values are 90 and 270).
The paper size.
The printable area.
Returns the paper rotation angle.
The page rotation angle, in degrees.
The paper rotation angle, in degrees.
If paper kind of the passed page settings is , scans the paper sizes
available on the specified printer, and if a match is found sets the paper
size from the printer to the one in page settings.
The page settings to adjust.
The target printer settings.
true if adjustment was made, false otherwise.
Gets the physical offset of the printed page, in 100th of an inch.
Handle to device context.
Left physical offset.
Top physical offset.
Gets the physical offset of the printed page, in 100th of an inch.
The on which the page is drawn.
OUT: Left physical offset.
OUT: Top physical offset.
Gets the printer landscape angle.
The printer settings to get the landscape angle for.
If this parameter is null or invalid, 270 is returned.
The printer landscape angle.
Represents information about a resolved .
For internal use only.
Gets or sets a value indicating whether the children processing is currently under way.
Gets or sets a value indicating whether auto size has been requested.
Gets or sets a value indicating whether auto height has been resolved.
Gets or sets a value indicating whether auto width has been resolved.
Represents a fragment of a in a resolved .
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Gets the that produced the current fragment.
Represents a fragment of a object.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Gets the that produced the current fragment.
Represents a fragment of a in a resolved .
Gets the that produced the current fragment.
Gets the object describing the geometric shape
represented by the current fragment's .
Represents a fragment of a in a resolved .
Gets the that produced the current fragment.
Gets the object describing the line
represented by the current fragment's .
Represents a fragment of a in a resolved .
Gets the that produced the current fragment.
Gets the object describing the line
represented by the current fragment's .
Represents a fragment of a in a resolved .
Gets the that produced the current fragment.
Gets the object describing the line
represented by the current fragment's .
For internal use only.
For internal use only.
Represents a fragment of a in a resolved .
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets the that produced the current fragment.
Gets the number of columns in the current table fragment
(i.e. on the current page or page column).
Gets the number of rows in the current table fragment
(i.e. on the current page or page column).
Gets the number of rows in the table header at the top of the current fragment
(i.e. on the current page or page column).
Gets the number of rows in the table footer at the bottom of the current fragment
(i.e. on the current page or page column).
Gets the number of columns in the vertical table header on the left of the current fragment
(i.e. on the current page or page column).
Gets the number of columns in the vertical table footer on the right of the current fragment
(i.e. on the current page or page column).
For internal use only.
Represents the resolved information about header/footer in table.
The TableVectorGroup object representing the title.
RenderFragments in header/footer.
Ordinals of vectors in header/footer.
Sizes of vectors in header/footer.
Indicates whether the header/footer is at the edge of object (top / left / right / bottom).
The size of title, if title is at edge of object then this side
does not include the additional space for gridline.
For internal use only.
If RenderTable.RepeateGridLinesHorz == true then
this list contains columns for which the grid lines ARE NOT REPEATED.
If RenderTable.RepeateGridLinesHorz == false then
this list contains columns for which the grid lines ARE REPEATED.
If RenderTable.RepeateGridLinesVert == true then
this list contains rows for which the grid lines ARE NOT REPEATED.
If RenderTable.RepeateGridLinesVert == false then
this list contains rows for which the grid lines ARE REPEATED.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
Gets or sets value indicating that the headers of table is resolved and
VertPageHeade, VertPageFooter properties contains valid values.
For internal use only.
Gets or sets value indicating that the headers of table is resolved and
HorzPageHeader, HorzPageFooter properties contains valid values.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
Internal use only.
For internal use only.
Internal use only.
For internal use only.
For internal use only.
For internal use only.
Index of vector in the _colsOrdinals or _rowsOrdinals array.
Split position within vector it is zero if split position
is between vectors.
Resolved info of repeated header.
Resolved info of repeated footer.
Defines area where split occurs.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
Describes the data and expressions refresh mode during document generation.
Neither expressions nor data are refreshed.
Note that if the document has not yet been generated, this mode is ignored
(i.e. data is refreshed and expressions are calculated).
Data is refreshed, all expressions are recalculated.
Expressions that do not reference data sources are recalculated,
but data is not refreshed.
Note that if the document has not yet been generated, this mode is ignored
(i.e. data is refreshed).
Represents types of errors that can occur during document generation.
No error.
The document contains a cyclic reference.
A dimension of an object cannot be resolved.
Auto width is not supported for an object.
Auto height is not supported for an object.
Auto size is not supported for an object.
Do not use.
Do not use.
Do not use.
Do not use.
Do not use.
Layout cannot be changed at that time.
Do not use.
Do not use.
Do not use.
Error in data binding.
Scripting error.
C1Report import error.
Rdl import error.
Error in processing document's tags.
Stores a set of four double numbers that represent the
offsets from the edges of a rectangular area.
Initializes a new instance of the structure.
The left offset.
The top offset.
The right offset.
The bottom offset.
Returns a string that represents the current .
A string that represents the current .
Converts a string to a structure.
The string to convert.
OUT: The structure.
Indicates whether an exception should be thrown if the string cannot be converted.
true if no error occurred, false otherwise.
Gets or sets the left offset.
Gets or sets the top offset.
Gets or sets the right offset.
Gets or sets the bottom offset.
Gets a value indicating whether the current is empty.
Represents an empty instance of the structure.
Represents a type converter for .
Converts a string to a .
An that provides a format context.
The string to convert.
The converted value.
Converts an object to a string.
An that provides a format context.
The to convert.
The converted string.
Stores a set of four integer numbers that represent the
offsets from edges of rectangular area.
Initializes a new instance of the structure.
The left offset.
The top offset.
The right offset.
The bottom offset.
Returns a string that represents the current .
A string that represents the current .
Converts the specified structure to an by
rounding the OffsetsD's double values to the next higher integer values.
The structure to be converted.
The converted structure.
Gets or sets the left offset.
Gets or sets the top offset.
Gets or sets the right offset.
Gets or sets the bottom offset.
Gets a value indicating whether the current is empty.
Represents an empty instance of the structure.
Represents an ordered pair of double X and Y coordinates that defines a point
in a two-dimensional plane.
Initializes a new instance of the structure.
The horizontal position of the point.
The vertical position of the point.
Converts the current to a human readable string.
A string that represents the current structure.
Converts the current structure to a by rounding the
double coordinates to the next higher integer values.
The structure this method converts to.
Converts the current structure to a by truncating
the values of the Point object.
The structure this method converts to.
Offsets the current structure by the specified values.
The horizontal offset.
The vertical offset.
Converts the current structure to a .
The structure this method converts to.
Converts a string to a structure.
The string to convert.
OUT: the created structure.
Indicates whether an exception should be thrown if the string cannot be converted.
true if no error occurred, false otherwise (if is false).
Adds a to a .
The that is added.
The that is added.
A representing the result of the addition.
Subtracts a from a .
The that is subtracted from.
The that is subtracted.
A representing the result of the subtraction.
Adds a to a .
The that is added.
The that is added.
A representing the result of the addition.
Subtracts a from a .
The that is subtracted from.
The that is subtracted.
A representing the result of the subtraction.
Gets or sets the X coordinate of the current .
Gets or sets the Y coordinate of the current .
Gets a value indicating whether the current is empty.
Represents an empty instance of the structure.
Represents a type converter for .
Converts a string to a .
An that provides a format context.
The string to convert.
The converted .
Converts a to a string.
An that provides a format context.
The to convert.
The string representing the .
Stores an ordered pair of double values, typically the width and height of a rectangle.
Initializes a new instance of the structure.
The horizontal component of the .
The vertical component of the .
Converts the current structure to a human-readable string representing it.
The string representing the current .
Converts the current structure to a by rounding the
width and height to the next higher integer values.
The structure this method converts to.
Converts the current structure to a by truncating the
width and height to integer values.
The structure this method converts to.
Adds two structures.
The first that is added.
The second that is added.
A representing the result of the addition.
Subtracts one structure from another.
The that is subtracted from.
The that is subtracted.
A representing the result of the subtraction.
Subtracts one structure from another.
The that is subtracted from.
The that is subtracted.
A representing the result of the subtraction.
Adds two structures.
The first that is added.
The second that is added.
A representing the result of the addition.
Gets or sets the horizontal component of the current .
Gets or sets the vertical component of the current .
Gets a value indicating whether of the current has zero and .
Represents an empty instance of the structure.
Stores a set of four double values that represent the location and size of a rectangle.
Initializes a new instance of the structure.
The location (coordinates of the top left corner) of the rectangle.
The size of the rectangle.
Initializes a new instance of the structure.
The X coordinate of the left side of the rectangle.
The Y coordinate of the top side of the rectangle.
The width of the rectangle.
The height of the rectangle.
Converts the current structure to a human-readable string representing it.
The string representing the current .
Tests whether the specified point is contained within the current .
The to test.
true if is contained within the current structure,
false otherwise.
Tests whether the specified rectangle is entirely contained within the current .
The to test.
true if is completely contained within the current structure,
false otherwise.
Tests whether a point specified by its coordinates is contained within the current .
The X coordinate of the point to test.
The Y coordinate of the point to test.
true if the specified point is contained within the current structure,
false otherwise.
Inflates the current by the specified amounts on four sides.
The amount to add on the left.
The amount to add at the top.
The amount to add on the right.
The amount to add on the bottom.
Inflates the current by a specified .
The to inflate the current rectangle by.
Inflates the current by specified horizontal and vertical amounts.
The amount to add on the left and right of the current .
The amount to add at the top and bottom of the current .
Replaces the current structure with the intersection
of itself and another .
The to intersect the current one with.
Tests whether the current intersects with another.
The to test.
true if the current intersects with , false otherwise.
Offsets the location of the current by specified horizontal and vertical amounts.
The horizontal offset to apply.
The vertical offset to apply.
Offsets the location of the current by horizontal and vertical amounts specified by a .
The specifying the horizontal and vertical offsets to apply.
Converts the current to a .
The converted structure.
Converts the current to a .
The converted structure.
Converts a string to a structure.
The string to convert.
OUT: the created structure.
Indicates whether an exception should be thrown if the string cannot be converted.
true if no error occurred, false otherwise (if is false).
Creates a structure based on the coordinates
of its top-left and bottom-right corners.
The X coordinate of the upper-left corner of the rectangular region.
The Y coordinate of the upper-left corner of the rectangular region.
The X coordinate of the lower-right corner of the rectangular region.
The Y coordinate of the lower-right corner of the rectangular region.
The newly created structure.
Creates a new structure from another RectangleD,
inflated by the specified amounts vertically and horizontally.
The a copy of which is created and inflated.
The amount by which to inflate the resulting rectangle horizontally.
The amount by which to inflate the resulting rectangle vertically.
The newly created structure.
Creates a new structure representing the intersection
of two RectangleD structures.
(The intersection may be empty, in which case is returned.)
The first to intersect.
The second to intersect.
The newly created structure.
Creates a new structure representing the smallest possible
rectangle containing the two specified rectangles.
The first to combine.
The second to combine.
The newly created structure.
Gets or sets the X coordinate of the top left corner of the current structure.
Gets or sets the Y coordinate of the top left corner of the current structure.
Gets or sets the width of the current structure.
Gets or sets the height of the current structure.
Gets the X coordinate of the left edge of the current structure.
Gets the Y coordinate of the top edge of the current structure.
Gets the X coordinate of the right edge of the current structure.
Gets the Y coordinate of the bottom edge of the current structure.
Gets or sets the coordinates of the top left corner of the current structure.
Gets or sets the size of the current structure.
Gets a value indicating whether the and
properties of the current structure have zero values.
Gets the coordinates of the top left corner of the current structure.
Gets the coordinates of the top right corner of the current structure.
Gets the coordinates of the bottom right corner of the current structure.
Gets the coordinates of the bottom left corner of the current structure.
Represents an empty instance of the structure.
Represents a type converter for .
Converts a string to a .
An that provides a format context.
The string to convert.
The converted .
Converts a to a string.
An that provides a format context.
The to convert.
The string representing the .
Represents a generated page of a .
Draws the current page on a .
The to draw on.
Indicates whether to draw input controls (see ).
Indicates whether to draw metafile comments, like outlines, hyperlinks etc.
Draws the current page on a .
The to draw on.
Indicates whether to draw input controls (see ).
Returns a representing the current page.
This method draws input controls.
The representing the current page.
Returns a representing the current page.
Indicates whether to draw input controls (see ).
The representing the current page.
Returns a representing the current page.
Specifies the metafile type.
Indicates whether to fill the page with white color before drawing.
The representing the current page.
Returns a representing the current page.
Specifies the reference graphics for the metafile.
Specifies the metafile type.
Indicates whether to fill the page with white color before drawing.
Indicates whether to draw input controls (see ).
The representing the current page.
Returns a representing the current page.
Specifies the reference graphics for the metafile.
Specifies the metafile type.
Indicates whether to fill the page with white color before drawing.
Indicates whether to draw input controls (see ).
Smoothing mode used for drawing.
The representing the current page.
Searches for a hyperlink at the specified position on the current page.
The position on the current page (in units).
A object containing information about the link, or null if none was found.
Searches for a at the specified position on the current page.
The position on the current page (in units).
The , or null if none was found.
Gets the collection of all hyperlinks on the current page.
The containing the information about the hyperlinks.
Gets the array of all objects on the current page.
The array of objects .
Gets a unique ID associated with the current page.
Gets the containing the current page.
Gets the representing the accept button for the current page.
Gets the logical horizontal coordinate of the current page in the document.
This property is 0 in documents that have no horizontal pages.
Gets the logical vertical coordinate of the current page in the document.
In documents without horizontal pages, this property corresponds
to the page number minus one.
Gets the object corresponding to the current page.
After the current page has been resolved, this property allows to retrieve
absolute values describing the geometry of the page, margins, and columns.
Note that if the current page has not been resolved yet,
the value of this property is null, so you should always
test it before accessing the nested properties.
Gets the for the current page.
Gets or sets the logical 1-based page number of the current page.
Gets or sets the logical page count.
Gets the containing the current page.
Gets a value indicating whether the collection for the current page
has been initialized and contains one or more elements.
Gets the collection of fragments for the current page.
Note that accessing this property always initializes the Fragments collection
if it has not been initialized yet. Use to test whether
the Fragments collection exists.
Gets the 0-based index of the current page in the containing collection.
Gets a value indicating whether the current page contains any objects
that belong to the of the document.
Represents a collection of objects in a .
Called when a page has been removed from the current collection.
The index of the removed page.
The page that has been removed.
Searches the current collection for a
with the specified logical coordinates
(identified by the and properties
on a page).
Specifies the logical horizontal coordinate of the page.
Specifies the logical vertical coordinate of the page.
The object that was found, or null.
Searches the current collection for a
with the specified logical page number.
Specifies the logical page number.
The object that was found, or null.
Gets the containing the current page collection.
Gets or sets the element at the specified index.
The index in the current collection.
The element at the specified index.
Gets the minimum logical page number in the current collection.
Gets the maximum logical page number in the current collection.
Gets the maximum logical horizontal page coordinate in the current collection.
Gets the maximum logical vertical page coordinate in the current collection.
Flags defining data binding mode.
The object is not data bound.
The object is bound to a valid data source via its property.
Some internal parts of the object are data bound,
for example if a group of rows within a RenderTable is data bound, this flag is on.
For internal use only.
Represents a of calculated
(and optionally data dependent) values.
Clears values in the current that are not data dependent).
Deletes a property value.
The property key.
Sets a property value.
The property key.
The property value.
true if the value is data dependent, false otherwise.
Tests whether a property is data dependent.
The property key.
true if the property is data dependent, false otherwise.
Represents a collection of fragments ()
of a .
All elements of this collection are sorted by
of the render object to perform drawing and searching.
Called when an element of the current collection is about to be set.
The index of the element.
The old value of the element.
The new value of the element.
Searches for a in the current collection
that was produced by a specific .
The render object to search for.
If true then fragment also will be searched in the collections of the objects contained in this collection.
The fragment that was produced by , or null if it was not found.
Gets the index of a in the current collection.
The fragment to get the index of.
The index of the specified fragment.
Searches for a in the current collection
that was produced by a specific .
The render object to search for.
The fragment that was produced by , or null if it was not found.
Searches for a in the current collection
that was produced by a with the specified .
The name to search for.
The fragment that was produced by the object with the specified name, or null if it was not found.
Searches for a in the current collection
that was produced by a with the specified .
The to search for.
The fragment that was produced by the object with the specified id, or null if it was not found.
Inserts a into the current collection
at a specified index.
The index at which to insert the fragment.
The fragment to insert.
Gets or sets the element at the specified index.
The index in the current collection.
The element at the specified index.
Represents a simple of objects.
This list is used to store copies of an object produced by data binding.
For internal use only.
Flags that allow a render object to manage its drawing.
No flags.
GDI will be used for drawing. In this case the object must override the method:
protected virtual void InternalDraw(GraphicsUtils.GdiDc dc, RectangleD boundsRect, RectangleD drawingBoundsRect);
If this flag is not specified, GDI+ will be used instead and the object must override the method:
protected virtual void InternalDraw(Graphics graphics, RectangleD boundsRect, RectangleD drawingBoundsRect);
Clipping will be defined before painting.
If specified then the object is not painted.
The standard painting of child objects is suppressed. The object must paint its children itself.
Special comment fields are added before and after fragment to the metafile,
specifying that the content is a hyperlink.
For internal use only.
Describes a split position.
Position in object relative to the top or left edge of object.
Space after available for object if is true.
Indicates that the break is "hard", i.e. the object must split exactly on .
Initializes a new instance of the structure.
A value to assign to .
A value to assign to .
A value to assign to .
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
True means that content should be clipped by InnerPx (RenderObject.Clip is true or fragement splitted as picture
Clipping rectangle.
Returns true if content is visible and should be drawn.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
Indicates that the column is started on split.
New page area was started on split and maximum space for object currently available.
Current page area where object will be placed.
X coordinate of point on CurPageArea where object will be placed.
Y coordinate of point on CurPageArea where object will be placed.
Contains saved resolved information for objects.
For internal use only.
Returns true if exists newly added objects with SplitIfLarge option.
Returns true if exists newly added objects with SplitNewPage option.
Marks all objects with SplitIfLarge option as processed.
Marks all objects with SplitNewPage option as processed.
Go over all newly added fragments with SplitIfLarge option
and check are they fit by vertical or not.
Top defines the top bound for objects, it should be used instead of pageArea.Bounds.Bottom
Go over all newly added fragments with SplitIfLarge option
and check are they fit by horizontal or not.
Left defines the left bound for objects, it should be used instead of pageArea.Bounds.Left
Returns true if object was newly added and has SplitIfLarge option.
Returns true if object was newly added and has SplitNewPage option.
Returns true if object has SplitIfLarge option and was marked as processed.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
Defines the split parameters for textual objects - RenderText, RenderParagraph and RenderRichText.
For internal use only.
For internal use only.
For internal use only.
Initializes a new instance of the class.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Represents a fragment of a in a resolved .
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Gets the that produced the current fragment.
Represents a fragment of a in a resolved .
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
For internal use.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets the that produced the current fragment.
For internal use only.
For internal use only.
Provides properties that allow to retrieve information about
a resolved , such as the actual absolute page size,
absolute margin values and so on.
All size and length values provided by this class are absolute,
expressed in .
Gets the object associated with the current .
Gets the total size of the current page, including margins (i.e. "paper size"),
in units.
Gets the area of the current page within the margins, relative to the
left top corner of the page,
in units.
Gets the current page margins,
in units.
Gets the number of columns on the current page.
Gets the array of values specifying
the column bounds on the current page,
in units.
Column bounds do not include page margins,
page header and footer areas, and gaps between the columns.
Gets the bounds of the header area on the current page,
in units.
Gets the bounds of the footer area on the current page,
in units.
For internal use only.
The base abstract class for all classes representing a resolved info about part of page:
header, footer, body, column.
For internal use only.
Gets a object during resolving of that was produced this
this object.
Gets the C1PrintDocument object containing this object.
Gets the bounds of page area within page.
For internal use only.
The base abstract class representing a page area
containg the nested objects.
Gets the count of columns in this part of page.
Enumerates columns by index.
Index of column.
Returns the PageColumn object representing column with specified index.
For internal use only.
Represents the nested page area containg references to the parent.
Initializes a new instance of the class.
Parent object.
Gets the ResolvedPage object containg this object.
For internal use only.
Gets a object during resolving of that was produced this
this object.
Gets the parent PageArea object containing this object.
For internal use only.
Describes the resolved layout of page.
Page can be represented as a set of rectangle, each rectangle is a part of page
(Header, Body or Footer), in turn a body of page consists of set of columns.
For internal use only.
Initializes a new instance of the class.
object during resolving of that was produced this object.
Gets the Page object containing this object.
Gets the PageAreaHeader object representing the resolved info about header of page.
Gets the PageAreaFooter object representing the resolved info about footer of page.
Gets the PageAreaBody object representing the resolved info about body of page.
Gets the full width of the page, margins are not taken into account.
Gets the full height of the page, margins are not taken into account.
For internal use only.
Represents the body of page - area excluding header and footer.
Initializes a new instance of the class.
The parent object.
For internal use only.
Returns an index of ths specified object.
object.
Returns an index of object.
Gets the count of columns in this part of page.
Enumerates columns by index.
Index of column.
Returns the PageColumn object representing column with specified index.
For internal use only.
Represents the column resolved info.
Initialized a new instance of the object.
Parent object.
Index of column in the page part.
For internal use only.
Gets the object containing this object.
Indicates whether the current column is a last column in its PageArea.
Indicates whether the current column is a first column in its PageArea.
Gets the next column, which goes after this column.
Gets the previous column, which goes prior this column.
Internal, describes the dimensions of object.
Left, Top, Right, Bottom - Absolute coordinates on page.
RelLeft, RelTop, RelRight, RelBottom - Relative coordinates in parent.
ChildLeft, ChildTop, ChildRight, ChildBottom - Relative coordinates for child objects,
ChildLeft and ChildTop are always 0,
ChildRight = Width - SpacingLeft - SpacingRight - PaddingLeft - PaddingRight - BordersLeft - BordersRight
Width, Height - sizes of object.
ChildWidth, ChildHeight - sizes for child objects, for example, ChildWidth is
Width - (SpacingLeft + BorderLeft + PaddingLeft) - (SpacingRight + BorderRight + PaddingRight).
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
For internal use only.
Represents information related to usage of a ,
such as the date and time when the document was last generated or printed.
Initializes a new instance of the class.
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Creates a copy of the current object.
The newly created object.
Clears all data stored in the current .
Gets or sets the date and time when a document was generated.
Gets or sets the date and time when a document was printed.
Gets or sets the name of the printer on which a document was last printed.
Gets or sets the file name that was last used to save or load a document.
For internal use only.
Contains addititional information about a metafile created by a .
In the metafile, the information is stored as a GDI comment record.
The format of the record is described by the structure.
Initializes a new instance of the class.
Initializes a new instance of the class.
The width of the metafile in mm.
The height of the metafile in mm.
The horizontal resolution (DPI).
The vertical resolution (DPI).
Indicates whether the metafile was created on a printer DC.
Initializes a new instance of the class.
The width of the metafile in mm.
The height of the metafile in mm.
The horizontal resolution (DPI).
The vertical resolution (DPI).
Creates a new instance of from a serialized as a string object.
A previously serialized object.
The newly created object.
Serializes the current object into a string.
The string representing the current object.
Writes the current object into a metafile's .
The graphics created from a .
Writes the current object into a metafile's device context.
The DC created from a .
Gets or sets the width of the metafile in mm.
Gets or sets the height of the metafile in mm.
Gets or sets the horizontal resolution of the metafile (DPI).
Gets or sets the vertical resolution of the metafile (DPI).
Gets or sets a value indicating whether the metafile was created on a printer DC.
Gets or sets the width of the metafile in device pixels.
Gets or sets the height of the metafile in device pixels.
Gets or sets the width of the metafile in points.
Gets or sets the height of the metafile in points.
For internal use only.
Represents a reader that can read a from a metafile.
Initializes a new instance of the class.
Enumerates a metafile searching for a GDI comment record containing
a previously serialized object.
If such a record is found, creates a new object,
deserializes the record into that object, and returns it.
The to enumerate.
The deserialized object, or null if none was found.
Disposes the current object.
Describes a font used in a
(see also ).
Assigns (copies) properties from another to the current object.
The source object to copy properties from.
Gets the containing the current object.
Gets a value indicating whether the collection is not empty.
Gets the name of the font as specified by the user.
For fonts created automatically due to font substitution,
this is still the name of the original specified font,
not of the substitute font.
Gets the name of the font file installed on the system or embedded in the document,
that is actually used to render the glyphs.
Gets the actual font family name. This name may be used in API calls
to create the corresponding font.
If has been set to
or
,
this name may differ from .
Gets the array of glyphs that were rendered using the current font.
Gets a value indicating whether the current font is bold.
Gets a value indicating whether the current font is italic.
Gets a value indicating whether the underlying physical font is bold.
Gets a value indicating whether the underlying physical font is italic.
Gets the of the current font.
Represents the collection of objects
describing fonts used in a .
See for details on
when and how this collection is populated.
Finds a font in the current collection with the specified values
of ,
and properties.
The to search for.
The value to search for.
The value to search for.
The font with the specified properties, or null.
Finds a font in the current collection with the specified values
of ,
and properties.
The to search for.
The value to search for.
The value to search for.
The font with the specified properties, or null.
Gets or sets a in the current collection by its index.
The index of the in the current collection.
The with the specified index.
For internal use only.
Provides static drawing-related utility methods.
Creates a with a specified size, centered within another rectangle.
The of the rectangle that must be centered within .
The outer within which to center the new rectangle.
The newly created and centered .
Creates a with a specified size, centered within another rectangle.
The of the rectangle that must be centered within .
The outer within which to center the new rectangle.
The newly created and centered .
Returns a representing the specified corner of a .
The target rectangle.
Integer identifying the corner to return:
0: top left,
1: top right,
2: bottom right,
3: bottom left.
The representing the specified corner.
Converts a to a .
The to convert.
The converted .
Zooms (scales) a by a specified zoom factor.
The to zoom.
The zoom factor.
The scaled .
Zooms (scales) a by a specified zoom factor.
The to zoom.
The zoom factor.
The scaled .
Zooms (scales) a by specified horizontal and vertical zoom factors.
The to zoom.
The horizontal zoom factor.
The vertical zoom factor.
The scaled .
Zooms (scales) a by a specified zoom factor.
The to zoom.
The zoom factor.
The scaled .
Zooms (scales) a by specified horizontal and vertical zoom factors.
The to zoom.
The horizontal zoom factor.
The vertical zoom factor.
The scaled .
Converts a to a .
The to convert.
The converted .
Creates a new from two opposing corners.
The identifying one of two opposing corners.
The identifying another of two opposing corners.
The newly created .
Creates a new from two opposing corners.
The identifying one of two opposing corners.
The identifying another of two opposing corners.
The newly created .
Swaps the width and height of a structure (rotates 90 degrees).
The to rotate.
The newly created with width and height swapped.
Contains information about a particular True Type font.
Creates a new instance of FontInfo for the specified .
The font to get info for.
Creates a new instance of FontInfo for the specified .
The font to get info for.
Gets the em size of the font, in font design units.
Gets the subscript size of the font, in font design units.
Gets the superscript size of the font, in font design units.
Gets the subscript size quotient.
Multiply the size of the font by this value to get the subscript size.
Gets the superscript size quotient.
Multiply the size of the font by this value to get the superscript size.
Gets the strikeout position, relative to the baseline, in design units.
Positive values are above the base line and negative values are below.
Gets the underscore position, relative to the baseline, in design units.
Positive values are above the base line and negative values are below.
Gets the underscore line thickness, in design units.
Gets the value indicating whether the font licensing allows embedding.
Gets the value indicating whether the font licensing requires obfuscating when embedded in XPS.
Gets the value indicating whether the font should be obfuscated when embedded in XPS.
Gets the value indicating whether the font licensing allows subsetting.
Gets the value indicating whether the font licensing restricts the font to read-only use.
For internal use only.
This interface should be implemented by a class if it needs to customize
the painting of metafiles in the
method.
The implementation should draw the metafile.
The to draw on.
The to draw.
The x-coordinate of the upper-left corner of the drawn image.
The y-coordinate of the upper-left corner of the drawn image.
The width of the drawn image.
The height of the drawn image.
For internal use only.
Identifes the creator of a metafile.
The creator of a metafile is unknown.
The creator of a metafile is a .
For internal use only.
Contains information about a metafile.
Indicates whether the metafile is created from a printer DC.
Gets the of the metafile.
Gets the resolution of the metafile.
Gets the DPI of the reference graphics which was used during metafile creation.
Gets the size of the metafile, calculated using .
Gets the size of the metafile, calculated using .
Represents information about a text run.
All characters in the run must have the same formatting,
and must not include line breaks.
For internal use.
Initializes a new instance of the class.
Text run string.
Text run rectangle
Gets the text run string.
Gets the text run rectangle.
Represents information about a text run.
All characters in the run must have the same formatting,
and must not include line breaks.
For internal use.
Initializes a new instance of the class.
Text run string.
Text run rectangle
Gets the collection of words within this text run.
Describes a word in the owner text run.
Offset of this word relative to the owner's left bound.
Position of this word's first char in the owner's .
Represents an instance of a found text.
For internal use.
For internal use.
For internal use.
Specifies a service interface allowing external code to persist designer settings.
Saves a string value with an arbitrary name.
The name.
The value.
Loads a string value with an arbitrary name.
The name.
The value.
Specifies a simple service container/provider.
Adds (registers) a service.
The service type.
The service instance.
Removes (deregisters) a service.
The service type.
Retrieves a registered service.
The service type.
The service instance.
Represents information about a potentially erroneous or conflicting situation
that occurred during generation of a .
Initializes a new instance of the class.
The code identifying the problem.
The human-readable problem description.
The object that triggered the problem.
Gets the code identifying the problem.
Gets the detailed description of the problem.
Gets the object which triggered the error.
Represents a collection of objects.
This is the type of the property
on a .
Adds a object to the current collection.
The warning to add.
The index of the added object in the current collection.
Gets or sets the element at the specified index.
The index in the current collection.
The element at the specified index.
A helper class that allows to use a slider control for a zoom factor value,
placing zoom factor 1 (no zoom) in the middle of the slider control.
Consider a 2cm long slider used to set zoom values in the range from 0.1 to 10
(i.e. from 10% to 1000%).
Using , the first centimeter of the slider
will correspond to zoom values from 10% to 100%, and the second centimeter
will correspond to zoom values from 100% to 1000%.
On the other hand if a simple linear slider were used,
all zoom values between 10% and 100% would have been squeezed into the
first two millimeters of the slider, making it very hard to set those values.
Initializes a new instance of the class.
Minimum allowed zoom factor (must be less than 1; 1 means no zoom).
Maximum allowed zoom factor (must be greater than 1; 1 means no zoom).
Minimum possible slider value.
Maximum possible slider value.
Converts a zoom factor to the corresponding slider value.
The zoom factor to convert (1 means no zoom).
The slider value.
Converts a slider value to the corresponding zoom factor.
The slider value to convert.
The zoom factor (1 means no zoom).