Telerik.Reporting
Represents an arrow shape.
Represents shape with rounded corners.
Base class for all shape types.
Initializes a new instance of the
with
zero angle of rotation.
Initializes a new instance of the
with
the specified angle of rotation in degrees.
A double value specifying the angle of rotation of the
shape in degrees.
When overridden this method should create the shape.
Adds a straight line to the shape.
The statr point of the line.
The end point of the line.
Adds a series of straight lines to the shape.
A point array representing the starting and ending points of the
lines.
A boolean value specifying whether to close the shape.
Adds a Bezier curve to the shape.
A point array representing the points of the Bezier curve.
Adds an ellipse to the shape.
The bounding rectangle of the ellipse.
Recreates the shape.
Gets the angle of rotation of this shape in radians.
A double value representing the angle of rotation of this
shape in radians.
Gets or sets the bounds of this shape.
A structure representing
the bounds of this shape.
Initializes a new instance of the
with the specified angle of rotation in degrees.
A double value specifying the angle of rotation of the
shape in degrees.
An int value between 0 and 100 specifying the rounding of
the edges in percentage.
Creates the shape.
When overridden this method should create shape
that will be rounded using the RoundVertexOp operator.
Gets or sets the rounding factor for the shape.
A double value between 0 and 100 specifying the rounding
factor of the shape in percentage. 0 means no rounding, 100 means full rounding.
Initializes a new instance of the
with
zero angle of rotation.
Initializes a new instance of the
with
the specified angle of rotation in degrees.
A double value specifying the angle of rotation of the
shape in degrees.
An int value between 0 and 100 specifying the rounding of
the edges in percent.
Creates the raw shape.
Returns a human-readable representation ot this
.
A human-readable representation ot this
.
Represents a Bezier curve segment of a shape.
Represents a shape segment.
Gets the points of this segment.
A point array representing the points of the segment.
Initializes a new instance of the
class
with the specified points.
A point array representing the points of the segment. The array
should contain 4 points -- start, control1, control2 and end.
Gets the points of this segment.
A point array representing the points of the segment.
Gets the start point of this segment.
The start point of the segment.
Gets the first control point of this segment.
The first control point of the segment.
Gets the second control point of this segment.
The second control point of the segment.
Gets the end point of this segment.
The end point of the segment.
Represents an cross shape.
Initializes a new instance of the
with
zero angle of rotation.
Initializes a new instance of the
with
the specified angle of rotation in degrees.
A double value specifying the angle of rotation of the
shape in degrees.
An int value between 0 and 100 specifying the rounding of
the edges in percent.
Creates the raw shape.
Returns a human-readable representation ot this
.
A human-readable representation ot this
.
Represents an ellipse segment of a shape.
Initializes a new instance of the
class
with the specified points.
A structure representing
the bounding rectangle of the segment.
Gets the bounding rectangle of the segment.
A structure representing
the bounding rectangle of the segment.
Gets the points of this segment.
A point array representing the points of the segment.
Represents an ellipse shape.
Initializes a new instance of the
with
zero angle of rotation.
Initializes a new instance of the
with
the specified angle of rotation in degrees.
A double value specifying the angle of rotation of the
shape in degrees.
Creates the shape.
Returns a human-readable representation ot this
.
A human-readable representation ot this
.
Represents the direction of a line in a shape.
Vertical line
Horizontal line
Top-Right - Bottom-Left line
Top-Left - Bottom-Right line
Represents line segment of a shape.
Initializes a new instance of the
class
with the specified points.
The start point of the line segment.
The end point of the line segment.
Gets the points of this segment.
A point array representing the points of the segment.
Gets the start point of this segment.
The start point of the segment.
Gets the end point of this segment.
The end point of the segment.
Gets the length of the line.
A float value representing the lenght of the line segment.
Represents a line shape.
Initializes a new instance of the
with EW line direction.
Initializes a new instance of the
with
specified line direction.
The direction of the line.
Creates the shape.
Returns a human-readable representation ot this
.
A human-readable representation ot this
.
The circle in polar coordinates.
x = x0 + R*cos(Alpha)
y = y0 + R*sin(Alpha)
Center of the circle
Radius of the circle
An angle, measured in radians
Returns the center of point of a rectangle
Returns the scaling factor to stretch the size of the source rectangle
to the size of the destination rectangle.
Rectangle to stretch
Rectangle to which the src rectangle will be stretched
if true the source rectangle will be scaled proportional by width and height;
otherwise the width/height ratio won't be preserved.
Factor [0 - 1]
0 - result === start
1 - result === end
Represents a polygon shape.
Represents the base class for all polygon shapes.
Initializes a new instance of the
with
the specified vertex count and angle of rotation in degrees.
The number of vertices of the polygon.
A double value specifying the angle of rotation of the
shape in degrees.
An int value between 0 and 100 specifying the rounding of
the edges in percent.
Creates the raw shape.
Gets the points of this shape.
The bound of the shape.
A point array representing the points of this shape.
Gets the core points for this shape.
The center of the shape.
The number of segments of the shape.
The radius of the shape.
The angle of rotation of the shape.
A point array representing the core points of this shape.
Initializes a new instance of the
with
3 vertexes and zero angle of rotation.
Initializes a new instance of the
with
the specified vertex count and zero angle of rotation.
The number of vertices of the shape.
Initializes a new instance of the
with
the specified vertex count and angle of rotation in degrees.
The number of vertices of the shape.
A double value specifying the angle of rotation of the
shape in degrees.
An int value between 0 and 100 specifying the rounding of
the edges in percent.
Gets the points of this shape.
The bound of the shape.
A point array representing the points of this shape.
Returns a human-readable representation ot this
.
A human-readable representation ot this
.
Scans the shape segments and for any 2 consecutive lines
splits the longer line in 2 parts so the vertex
will occur between 2 equal lines.
L2
+-----
/ L1' == L2
L1 ./
/
/ L1"
/
Represents a star shape.
Initializes a new instance of the
with
3 vertexes, 50% concavity, and zero angle of rotation.
Initializes a new instance of the
with
the specified vertex count, 50% concavity, and zero angle of rotation.
The number of vertices of the shape.
Initializes a new instance of the
with
the specified vertex count, concavity, and angle of rotation in degrees.
The number of vertices of the shape.
The concavity in percent of the shape.
A double value specifying the angle of rotation of the
shape in degrees.
An int value between 0 and 100 specifying the rounding of
the edges in percent.
Gets the points of this shape.
The bound of the shape.
A point array representing the points of this shape.
Returns a human-readable representation ot this
.
A human-readable representation ot this
.
Gets or sets a percent value specifying the concavity of the shape.
An int value between 0 and 100 specifying the concavity
of the shape in percentage.
Represents a selector that matches a property value of a report item.
Selectors are defined for each
in the
.
AttributeSelector should be used when you want to match all
report items of a certain Type that have a property set to a
certain value.
Provides the abstract base class for an attribute selector.
Selectors are defined for each
in the
.
Represents a selector base on a
Allows an object to implement a style selector, and represents a set
of methods to match a
and clone the selector.
Matches a based on
certain criteria.
The to match.
true if item matches; otherwise false.
Shortcut for all built-in types: appear as type names only in the type selector
Initializes a new type that matches any type of report item.
Initializes a new instance of the
class that
matches any type of report item.
Initializes a new instance of the
class that
matches items of the specified type.
The that this selector
matches.
Matches a based on
its type.
The to match.
true if item matches; otherwise false.
Performs a deep clone of the
.
The cloned
Copies this TypeSelector to the specified typeSelector.
The to copy
to.
Called when the
of this
selector changes.
Creates a human-readable string that represents this
.
A string that represents this TypeSelector.
Gets or sets the that this selector
matches.
A value to match.
The property descriptor associated with the property that this
selector matches.
The name of the property to match.
The value of the property to match.
Initializes a new instance of the AttributeSelectorBase
class with an empty property name and value, that matches all
objects.
Initializes a new instance of the AttributeSelectorBase
class with the specified property name and value, that matches all
objects.
A string value indicating the property name to match.
A string value indicating the property value to match.
Initializes a new instance of the AttributeSelectorBase
class with the specified property name and value, that matches
items of the specified type.
A value indicating the type of the items
to match.
A string value indicating the property name to match.
A string value indicating the property value to match.
Copies the property name and value of the selector to the target
typeSelector.
The to copy
to.
Matches a report item by the value of its property.
The to match.
true if the item's property value matches.
This member overrides
A string value describing the selector.
This member overrides
.
The method resets the selector.
Gets or sets the name of the property to match.
The name of the property to match.
Gets or sets the value of the property to match.
The value of the property to match.
Default ColorPalette
A common interface for all the color palette implementations.
Represents a background image associated with a
Initializes a new instance of the BackgroundImage class as
a member of the given
A value representing
the parent style of the BackgroundImage.
Gets or sets a
value
defining the repeat style of the BackgroundImage.
A value
representing the repeat style of the BackgroundImage.
Gets or sets a containing the
image data of this BackgroundImage.
A object containing the
image data of this BackgroundImage.
Use this property if you want to bind the BackgroundImage
to an image that is not in the data source.
Gets or sets the MIME type of the current
object.
The MIME type of the current BackgroundImage object.
Indicates how a background image will be repeated.
The background-image will be displayed only once.
The background image will be repeated horizontally.
The background image will be repeated vertically.
The background image will be repeated vertically and horizontally.
A class used to specify the color of the border of an item.
Gets or sets the default color of the border.
The default border .
Gets or sets the top color of the border.
The top border .
Gets or sets the bottom color of the border.
The bottom border .
Gets or sets the left color of the border.
The left border .
Gets or sets the right color of the border.
The right border .
A class used to specify the color of the border of an item.
A class used to specify the style of the border of an item.
Gets or sets the default style of the border.
A object
specifying the default border style.
Gets or sets the top style of the border.
A object
specifying the top border style.
Gets or sets the bottom style of the border.
A object
specifying the bottom border style.
Gets or sets the left style of the border.
A object
specifying the left border style.
Gets or sets the right style of the border.
A object
specifying the right border style.
Specifies the type of a border.
No line.
A solid line.
A dotted line.
A dashed line.
A double solid line.
A grooved line for a sunken border appearance.
A ridged line for a raised border appearance.
An inset line for a sunken item appearance.
An outset line for a raised item appearance.
A class used to specify the width of the border of an item.
Gets or sets the default width of the border.
A
specifying the default border width.
Gets or sets the top width of the border.
A
specifying the top border width.
Gets or sets the bottom width of the border.
A
specifying the bottom border width.
Gets or sets the left width of the border.
A
specifying the left border width.
Gets or sets the right width of the border.
A
specifying the right border width.
Represents a collection of user-selected colors.
Converts the collection to string returning the count of items in it.
Parameter; Binding ...
Parameters; Bindings ...
Represents a selector that matches an item that is a descendant of
another item.
At times, authors may want selectors to match an item that is the
descendant of another item in the report item tree (e.g., "Match those
TextBox elements that are contained by a Panel element"). Descendant
selectors express such a relationship in a pattern.
Initializes a new instance of the DescendantSelector.
Initializes a new instance of the DescendantSelector
class with the specified selectors.
A array
containing the selectors that define the descendance pattern used
to match the item.
Matches a report item based on the descendance pattern defined by
the
of this selector.
The to match.
true if the item matches the descendance pattern.
This member overrides
A string value describing the selector.
Gets a
containing the selectors that define the descendance pattern used
to match the item.
Represents an external style sheet used to style a report.
Initializes a new instance of the class.
Creates a new ExternalStyleSheet with the given resource identifier.
The identifier for the resource
containing the external style sheet. This parameter can be an
absolute or relative filepath, an absolute or relative URL, or the
name of an embedded resource.
Creates a new ExternalStyleSheet by loading it from the specified
stream.
The stream to load from.
Creates a new ExternalStyleSheet by loading it from the specified
Uri.
The Uri to load from.
Represents a collection of
objects.
Each time an
object is inserted, deleted or set in this collection, the
that owns the collection is
refreshed by re-applying or internal and external style sheets.
ExternalStyleSheetCollectionConverter
ExternalStyleSheetConverter
Defines a particular format for text, including font face, size, and
style attributes.
This member overrides
A string value describing the Font.
Converts the specified reporting
to a
.
The to convert.
The that is converted from the
specified reporting Font structure.
Gets or sets the face name of this
.
A string representation of the face name of this Font.
Gets or sets the size of this
measured in
s.
The size of this
Font.
Gets a value that indicates whether this
is bold.
true if this Font is bold; otherwise, false.
Gets a value that indicates whether this
is italic.
true if this Font is italic; otherwise, false.
Gets a value that indicates whether this
is underlined.
true if this Font is underlined; otherwise, false.
Gets a value that indicates whether this
specifies a horizontal
line through the font.
true if this Font has a horizontal line through it;
otherwise, false.
Gets or sets style information for this
.
A enumeration that contains
style information for this Font.
Represents a base class for all Telerik Reporting objects
This method supports the Telerik Reporting infrastructure
and is not intended to be used directly from your code.
Style to copy the values from.
Style to copy the values to.
Indicates whether to copy all the style properties of the src style (if true)
or only the explicitly set values for the src style.
Indicates whether to copy only the different properties (if true)
or all style properties.
Indicates whether if the current rule is applied to proceed
with the next FormattingRule in the ReportItemBase.ConditionalFormattings
collection.
A color palette that generates transitional colors based on a continuous linear gradient between two base colors.
Specifies the horizontal alignment of the text in a report item.
Specifies that the text is aligned to the left.
Specifies that the text is aligned to the center.
Specifies that the text is aligned to the right.
Specifies that the text is justified.
Specifies how an image is positioned within an item.
Grows or shrinks borders of the image item to fit the image.
The image is displayed in the center of the item.
If the image is larger than the item, the image is clipped.
Clips the image to fit the height and width of the item.
Resizes the image to match the height and width of the item.
Resizes the image to match the height and width of the item,
preserving the aspect ratio.
Specifies the type of a line item
A solid line.
A dashed line.
A dotted line.
A color palette that provides colors generated using a variable lightness between defined minimum and maximum values.
Gets or sets a value defining the minimal lightness of the generated colors
Value between 0M and 0.5M
Gets or sets a value defining the maximal lightness of the generated colors
Value between 0.5M and 1M
Represents padding information associated with a report item.
The padding is the internal space between the body of the item and its
edge.
Padding has a different effect on report items that are containers than
on report items that are not. For example, in a
item, the Padding property
defines the spacing between the border of the Panel and its
child items. For a item, the
Padding property defines the spacing between the border of the
TextBox item and its contained text.
Initializes a new instance of the Padding class as
a member of the given
A value representing
the parent style of the Padding.
This member overrides
A string value listing the Padding's members.
Gets or sets the padding value for the left edge.
The padding, in s, for
the left edge.
Gets or sets the padding value for the right edge.
The padding, in s, for
the right edge.
Gets or sets the padding value for the top edge.
The padding, in s, for
the top edge.
Gets or sets the padding value for the bottom edge.
The padding, in s, for
the bottom edge.
Specifies settings that apply to a single, printed page.
The PageSettings class is used to specify settings that modify
the way a page will be printed.
Initializes a new instance of the PageSettings
class with the specified
and
.
A object
specifying the landscape and paper kind.
A object
specifying the papers size and margins.
This member implements
The cloned PageSettings.
Returns a
object based on the given
parameter.
A object
from which to create the
.
A object
initialized from the printerSettings.
Gets or sets the paper kind for the page.
A that represents
the kind of the paper.
Gets or sets the paper size for the page.
A that represents
the size of the paper.
Gets or sets a value indicating whether the page is printed in
landscape or portrait orientation.
true if the page should be printed in landscape orientation;
otherwise, false.
Gets or sets the margins for this page.
A that represents
the margins for the page.
Specifies a collection of watermarks for the page.
Gets or sets a value that specifies how many columns are present
in the of the report.
An integer value specifying the number of columns.
The value should be equal to or greater than 1. The default is 1.
Column widths are calculated based on the following rule:
DetailWidth = ColumnWidth * ColumnCount +
ColumSpacing * (ColumnCount - 1)
Multi-column reports are primarily used for printing labels.
Gets or sets a value indicating the space in Units between two
adjacent columns.
A value specifying the
space between two adjacent columns. The value should be a
non-negative Unit. The default is
This property should be used when there should be some blank space
left between adjacent columns.
Gets or sets the background color of the page.
A that represents the background
color of the page. The default is
, which indicates that this
property is not set.
Use the BackColor property to specify the background color
of the page. This property is set using a
object.
Gets a object
used to define the page border style.
A representing
the page border style.
You can set the page border style by using the properties
,
,
,
, and
.
The Default property is used to set all borders styles at
once. All borders are
BorderType.None by default.
Gets a object
used to define the page border color.
A representing
the page border color.
You can set the page border color by using the properties
,
,
,
, and
.
The Default property is used to set all borders colors at
once. All borders are
by default.
Gets a object
used to define the page border width.
A representing
the page border width.
You can set the page border width by using the properties
,
,
,
, and
.
The Default property is used to set all borders widths at
once. All borders are 1pt wide by default.
Gets a
object that controls the image displayed in the background of the
page.
An that
represents the image to display in the background of the report
item. Report items have no background image by default.
Non-expandable SizeU Converter
Represents a picture watermark on a printable page.
Represents a watermark on a printable page.
Gets or sets the position of the watermark relative to the other
items on the printable page.
A value
that specifies the position of the watermark relative to the other
items on the printable page.
Gets or sets the opacity of the watermark when combining it with the
other items on the printable page.
A value that specifies the opacity of the watermark when combining it
with the other items on the printable page.
The value can be specified in the range from 0.0 to 1.0, where 0.0 is
completely transparent, while 1.0 is completely opaque. Any other value
outside that range is clamped to the closest allowed value.
Gets or sets a value indicating whether to print the watermark on
the first printable page of the report.
A boolean value indicating whether to print the watermark on the
first printable page of the report.
Gets or sets a value indicating whether to print the watermark on
the last printable page of the report.
A boolean value indicating whether to print the watermark on the
last printable page of the report.
Gets or sets the image of the watermark to be printed on the page.
The image of the watermark to be printed on the page.
The specified image can be in one of the following supported formats:
an object instance inherited from ;
an array of bytes containing binary image data; a local file path
or an URL to an external image file. Instead of providing the image
directly, it is possible to specify it indirectly as an expression
that is evaluated at runtime for each printable page. If the image
is null (Nothing in Visual Basic), or if the specified expression
evaluates to null (Nothing in Visual Basic), the watermark is not
printed on the current page.
The following expression prints a watermark on every second page:
= IIf(PageNumber % 2 = 0, "Watermark.png", Null)
Gets or sets the sizing mode of the watermark image on the printable page.
A value that
specifies the sizing mode of the watermark image on the printable page.
Represents an ordered pair of unit-based point x- and y-coordinates
that defines a point in a two-dimensional plane.
Represents a new instance of the
class with member
data left uninitialized.
Initializes a new instance of the PointU class with the specified
coordinates.
The horizontal position of the point.
The vertical position of the point.
Translates the PointU by the specified SizeU.
The to translate.
The that specifies
the numbers to add to the x- and y-coordinates of the
PointU.
The translated PointU.
The op_Addition operator adds the
of the
specified size to the x-coordinate of the PointU and the
to the
y-coordinate of the PointU.
Translates the PointU by the negative of a specified
SizeU.
The to translate.
The that specifies
the numbers to subtract from the x- and y-coordinates of the
PointU.
The translated PointU.
The op_Subtraction operator subtracts the
of the
specified size from the x-coordinate of the PointU and the
from the
y-coordinate of the PointU.
Compares two PointU structures. The result specifies whether
the values of the
and properties of
the two PointU structures are equal.
A to compare.
A to compare.
true if the X and Y values of the left and
right PointU structures are equal; otherwise, false.
Determines whether the coordinates of the specified points are not
equal.
A to compare.
A to compare.
true to indicate the
and
values of
pt1 and pt2 are not equal; otherwise, false.
Converts the specified reporting
to a
.
The to convert.
The that is converted from the
specified reporting Point structure.
Converts the specified reporting
to a
.
The to convert.
The that is converted from the
specified reporting Point structure.
Specifies whether this
contains the same
coordinates as the specified Object.
The to test.
This method returns true if obj is a PointU
and has the same coordinates as this
.
Returns a hash code for this
structure.
An integer value that specifies a hash value for this PointU
structure.
Converts this to a
human readable string.
A string that represents this PointU.
Converts this to a
human readable string according to the
specified.
A that is used to
format the string.
A string that represents this PointU.
Offsets this
structure by a specified amount in the x- and y-direction.
A value specifying
the amount to offset in the horizontal direction.
A value specifying
the amount to offset in the vertical direction.
Gets or sets the x-coordinate of this
The x-coordinate of this PointU.
Gets or sets the y-coordinate of this
The y-coordinate of this PointU.
Gets a value indicating whether this
is empty.
true if both
and
are equal to zero;
otherwise, false.
Stores a set of four Unit-based numbers that represent the location and
size of a rectangle.
A RectangleU is defined by its width, height, and upper-left
corner.
Represents an instance of the
class with its
members uninitialized.
The members of the new RectangleU are left uninitialized.
Initializes a new instance of the
class from the
specified .
A that represents the
rectangular region.
Initializes a new instance of the
class from the
specified .
A that represents the
rectangular region.
Initializes a new instance of the
class with the
specified location and size.
A that represents
the upper-left corner of the rectangular region.
A that represents the
width and height of the rectangular region.
Initializes a new instance of the
class with the
specified location and size.
The x-coordinate of the upper-left corner of the rectangle.
The y-coordinate of the upper-left corner of the rectangle.
The width of the rectangle.
The height of the rectangle.
Tests whether two RectangleU structures have equal location
and size.
The structure
that is to the left of the equality operator.
The structure
that is to the right of the equality operator.
This operator returns true if the two specified
RectangleU structures have equal
,
,
, and
properties.
Tests whether two RectangleU structures differ in location
or size.
The structure
that is to the left of the equality operator.
The structure
that is to the right of the equality operator.
This operator returns true if any of the
,
,
, or
properties of the two
structures are unequal; otherwise false.
Converts the specified RectangleU structure to a
structure.
The structure
to convert.
The Rectangle structure that is converted from the specified
RectangleU structure.
Converts the specified RectangleU structure to a
structure.
The structure
to convert.
The RectangleF structure that is converted from the specified
RectangleU structure.
Determines if the specified point is contained within this
RectangleU structure.
The x-coordinate of the point to test.
The x-coordinate of the point to test.
This method returns true if the point defined by x
and y is contained within this RectangleU structure;
otherwise false.
Determines if the specified point is contained within this
RectangleU structure.
The to test.
This method returns true if the point represented by the
pt parameter is contained within this RectangleU
structure; otherwise false.
Determines if the rectangular region represented by rect is
entirely contained within this RectangleU structure.
The to test.
This method returns true if the rectangular region
represented by rect is entirely contained within the
rectangular region represented by this RectangleU; otherwise
false.
Inflates this RectangleU structure by the specified amount.
The amount to inflate this
structure
horizontally.
The amount to inflate this
structure
vertically.
Inflates this RectangleU structure by the specified amount.
The amount to inflate this rectangle.
Inflates rect by the specified amount.
The structure
to inflate.
The amount to inflate this
structure
horizontally.
The amount to inflate this
structure
vertically.
The inflated RectangleU structure.
Determines if this rectangle intersects with rect.
The rectangle to test.
This method returns true if there is any intersection;
otherwise false.
Adjusts the location of this rectangle by the specified amount.
The amount to offset the location.
Adjusts the location of this rectangle by the specified amount.
The amount to offset the location horizontally.
The amount to offset the location vertically.
Tests whether obj is a
with the same
location and size of this RectangleU.
The to test.
This method returns true if obj is a
RectangleU and its X, Y, Width, and
Height properties are equal to the corresponding properties
of this RectangleU; otherwise, false.
Converts the Location and Size of this
RectangleU to a human-readable string.
A human-readable representation of the rectangle.
Converts the Location and Size of this
RectangleU to a human-readable string.
A object according
to which to format the string.
A human-readable representation of the rectangle.
Returns a hash code for this
structure.
An integer value that specifies a hash value for this
RectangleU structure.
Gets or sets the x-coordinate of the upper-left corner of this
structure.
The x-coordinate of the upper-left corner of this RectangleF
structure.
Gets or sets the y-coordinate of the upper-left corner of this
structure.
The y-coordinate of the upper-left corner of this RectangleF
structure.
Gets or sets the width of this
structure.
The width of this RectangleF structure.
Gets or sets the height of this
structure.
The height of this RectangleF structure.
Gets or sets the coordinates of the upper-left corner of this
structure.
A that represents
the upper-left corner of this RectangleF structure.
Gets or sets the size of this
.
A that represents the
width and height of this RectangleU structure.
Gets the x-coordinate of the left edge of this
structure.
The x-coordinate of the left edge of this
RectangleU structure.
Gets the y-coordinate of the left edge of this
structure.
The y-coordinate of the left edge of this
RectangleU structure.
Gets the x-coordinate that is the sum of
and
of this
RectangleU structure.
The x-coordinate that is the sum of X and Width of
this RectangleU structure.
Gets the y-coordinate that is the sum of
and
of this
RectangleU structure.
The y-coordinate that is the sum of Y and Height of
this RectangleU structure.
Tests whether the
,
,
, and
properties of this
have a value of
zero.
This property returns true if the X, Y,
Width, and Height properties of this
RectangleU have a value of zero; otherwise, false.
Represents a collection of objects that implement
Initializes a new instance of the
class.
Adds an array of selector objects to the collection.
An array of
objects to add to the collection.
The ISelector objects contained in the
selectors array are appended to the end of the collection.
You can use the AddRange method to quickly add a
group of ISelector objects to the collection
instead of manually adding each ISelector to the
collection using the
method.
To remove a
that you
previously added, use the
,
,
or
methods.
Compares two ISelector instances.
Compares two ISelector instances.
-1 if x is weaker (less determinant) selector.
1 if y is weaker (less determinant) selector.
0 if x and y have the same weight
Stores an ordered pair of Unit-based numbers, typically the width and
height of a rectangle.
Initializes a new instance of the
class.
Initializes a new instance of the SizeU class from the
specified existing Size.
The from which to create the new
SizeU.
Initializes a new instance of the SizeU class from the
specified existing SizeF.
The from which to create the new
SizeU.
Initializes a new instance of the SizeU class from the specified
dimensions.
The width component of the new
.
The height component of the new
.
Adds the width and height of one SizeU structure to the
width and height of another SizeU structure.
The first to add.
The second to add.
A structure that is
the result of the addition operation.
Subtracts the width and height of one SizeU structure from
the width and height of another SizeU structure.
The on the left side
of the subtraction operator.
The on the right side
of the subtraction operator.
A structure that is
the result of the subtraction operation.
Tests whether two SizeU structures are equal.
The structure on the
left side of the equality operator.
The structure on the
right side of the equality operator.
This operator returns true if size1 and size2
have equal width and height; otherwise, false.
Tests whether two SizeU structures are different.
The structure on the
left side of the equality operator.
The structure on the
right side of the equality operator.
This operator returns true if size1 and size2
differ either in width or height; false if size1 and
size2 are equal.
Converts the specified SizeU to a
.
The structure to be
converted.
The structure to which this
operator converts.
Converts the specified SizeU to a
.
The structure to be
converted.
The structure to which this
operator converts.
Tests to see whether the specified object is a
with the same
dimensions as this SizeU.
The to test.
This method returns true if obj is a
and has the same
width and height as this SizeU; otherwise, false.
Returns a hash code for this
structure.
An integer value that specifies a hash value for this SizeU
structure.
Creates a human-readable string that represents this
.
A string that represents this SizeU.
Creates a human-readable string that represents this
.
A object according
to which to format the string.
A string that represents this SizeU.
Gets or sets the horizontal component of this
.
The horizontal component of this SizeU.
Gets or sets the vertical component of this
.
The vertical component of this SizeU.
Gets a value indicating whether this
has zero width and
height.
This property returns true when this SizeU has both
a width and height of zero; otherwise, false.
Represents the style of a report item.
Gets or sets a value indicating whether the report item is
displayed.
true if the report item is displayed; otherwise,
false. The default is true.
Gets or sets the background color of the report item.
A that represents the background
color of the report item. The default is
, which indicates that this
property is not set.
Use the BackColor property to specify the background color
of the report item. This property is set using a
object.
Gets a
object that controls the image displayed in the background of the
report item.
An that
represents the image to display in the background of the report
item. Report items have no background image by default.
Gets or sets the foreground color of the report item.
The foreground of the report
item. The default is .
Gets or sets the horizontal indentation of the first line of text in the report item.
The indentation in s.
The default is
.
Gets or sets the horizontal alignment of text in the report item.
One of the
values.
The default is
HorizontalAlign.Left.
Gets or sets the vertical alignment of text in the report item.
One of the
values.
The default is VerticalAlign.Top.
Gets a object
used to define the border style of a report item.
A representing
the border style of the report item.
You can set the border style of the item by using the properties
,
,
,
, and
.
The Default property is used to set all borders styles at
once. All borders are
BorderType.None by default.
Gets a object
used to define the border color of a report item.
A representing
the border color of the report item.
You can set the border color of the item by using the properties
,
,
,
, and
.
The Default property is used to set all borders colors at
once. All borders are
by default.
Gets a object
used to define the border width of a report item.
A representing
the border width of the report item.
You can set the border width of the item by using the properties
,
,
,
, and
.
The Default property is used to set all borders widths at
once. All borders are 1pt wide by default.
Gets a object
representing the font of the report item.
A object used to
define the font of a report item. By default the font of a report
item is Arial-Regular, 10pts.
Gets a object
used to define the padding of a report item.
A object
representing the padding of the report item.
You can set the padding of the item by using the properties
,
,
, and
.
Padding on all sides is
by default.
Gets or sets a
object used to define the line style of report items that
support it, such as lines and shapes.
A object
representing the line style of the report item. By default the line
style is LineStyle.Solid.
Gets or sets a
representing the line width of report items that support it, such
as lines and shapes.
A value representing
the line width of the report item. By default the width is 1pt.
Gets or sets the (stroke)
representing the line color of report items that support it, such
as lines and shapes.
A value representing
the line color of the report item. By default its value is Black.
Performs the specified action on each registered Style property key.
Represents a style rule to be applied.
Initializes a new empty
.
Returns a human-readable representation ot this
.
A human-readable representation ot this
.
A collection of selectors that determine which report items the
style applies to.
A object
containing all of the selectors for this rule.
The to apply to all
report items selected by the
A object defining the
style of this
Represents a collection of
objects.
Initializes a new instance of the
class.
Adds an array of style rule objects to the collection.
An array of
objects to add to the collection.
The StyleRule objects contained in the
rules array are appended to the end of the collection.
You can use the AddRange method to quickly add a
group of StyleRule objects to the collection
instead of manually adding each StyleRule to the
collection using the
method.
To remove a
that you
previously added, use the
,
,
or
methods.
An attribute selector based on the style name property.
Initializes a new
.
Initializes a new
with the
specified style name.
A string value specifying the style name to
match.
Initializes a new
with the
specified style name, that matches items of the specified
The of items to match.
A string value specifying the style name to
match.
Returns a human-readable representation of this
.
A human-readable representation of this
.
Gets or sets the name of the style that this selector matches.
A string value representing the style name to match.
Represents a collection of styles for a
templateStringFormat will not be automatically disposed.
Represents a text watermark on a printable page.
Gets or sets the text of the watermark to be printed on the page.
A started with "=" is interpreted as
an expression to calculate the real data,
otherwise - literal string.
Supports embedded expressions also.
The text can be specified either directly as a string literal or
indirectly as an expression that is evaluated at runtime for each
printable page. If the text is null (Nothing in Visual Basic) or
an empty string, or if the specified expression evaluates to null
(Nothing in Visual Basic) or an empty string, the watermark is not
printed on the current page.
The following expression prints a watermark on every second page:
= IIf(PageNumber % 2 = 0, "Watermark", Null)
Gets or sets the color of the watermark text.
A value that specifies the color
of the watermark text without the transparency.
Gets or sets the orientation of the watermark text on the printable page.
A value that
specifies the orientation of the watermark text on the printable page.
Gets the font settings of the watermark text.
A value that specifies
the font settings of the watermark text.
A structure representing a unit of measure.
Initializes a new instance of the
structure.
Initializes a new instance of the
structure equal to
zero.
Creates a new
of type UnitType.Pixel and magnitude equal to value.
A double value specifying the magnitude of the Unit.
The created Unit.
Creates a new
of type UnitType.Pixel
and magnitude equal to value.
An int value specifying the magnitude of the Unit.
The created Unit.
Creates a new
of type UnitType.Point
and magnitude equal to value.
A double value specifying the magnitude of the Unit.
The created Unit.
Creates a new
of type UnitType.Point
and magnitude equal to value.
An int value specifying the magnitude of the Unit.
The created Unit.
Creates a new
of type UnitType.Cm
and magnitude equal to value.
A double value specifying the magnitude of the Unit.
The created Unit.
Creates a new
of type UnitType.Cm
and magnitude equal to value.
An int value specifying the magnitude of the Unit.
The created Unit.
Creates a new
of type UnitType.Mm
and magnitude equal to value.
A double value specifying the magnitude of the Unit.
The created Unit.
Creates a new
of type UnitType.Mm
and magnitude equal to value.
An int value specifying the magnitude of the Unit.
The created Unit.
Creates a new
of type UnitType.Inch
and magnitude equal to value.
A double value specifying the magnitude of the Unit.
The created Unit.
Creates a new
of type UnitType.Inch
and magnitude equal to value.
An int value specifying the magnitude of the Unit.
The created Unit.
Creates a new
of type UnitType.Pica
and magnitude equal to value.
A double value specifying the magnitude of the Unit.
The created Unit.
Creates a new
of type UnitType.Pica
and magnitude equal to value.
An int value specifying the magnitude of the Unit.
The created Unit.
Initializes a new instance of the
structure from the
specified pixels. The Unit's type is
A double value specifying the magnitude of the
in pixels.
Initializes a new instance of the
structure with the
specified value and type.
A double value representing the magnitude of the
Unit.
A specifying the
type of the Unit.
Initializes a new instance of the
structure from the
specified string value.
A string value representing the magnitude and type of the
Unit.
Parameters passed to this constructor should be of the form "2px",
"3.4in", "4cm", "2mm", "12.5pt", "4pc", etc. For more information
on string representations of units see
.
Initializes a new instance of the
structure from the
specified string value and using the specified
.
A string value representing the magnitude and type of the
Unit.
A . If a null
reference (Nothing in Visual Basic) is passed, the current
culture is assumed.
The culture parameters is used to parse the string value.
Initializes a new instance of the
structure from the
specified string value, culture, and type.
A string value representing the magnitude of the
Unit.
A . If a null
reference (Nothing in Visual Basic) is passed, the current
culture is assumed.
A specifying the
type of the Unit.
Parses a string value to create a new Unit.
A string value defining the unit.
The created Unit.
The parameter passed to this Method should be of the form "2px",
"3.4in", "4cm", "2mm", "12.5pt", "4pc", etc. For more information
on string representations of units see
.
Parses a string value to create a new Unit based on the
specified culture.
A string value defining the unit.
The object defining
the rules for the parsing.
The created Unit.
The parameter passed to this Method should be of the form "2px",
"3.4in", "4cm", "2mm", "12.5pt", "4pc", etc. For more information
on string representations of units see
.
Returns a unit equal to this
but with its type
changed.
The to change to.
A Unit equal to this Unit, but with type that equals
type.
Returns a that is the
sum of two units and is of the specified type.
The first Unit.
The second Unit.
A specifying the
type of the resultant unit.
The sum of the two units.
Returns a that is the
sum of two units and its unit type matches the first argument type.
The first Unit.
The second Unit.
The sum of the two units in the unit type of the first argument unit.
Returns a that is the
difference of two units and is of the specified type.
The Unit to subtract from.
The Unit to subtract.
The difference of the two units in the unit type of the first argument unit.
Returns a that is the
difference of two units and is of the specified type.
The Unit to subtract from.
The Unit to subtract.
A specifying the
type of the resultant unit.
The difference of the two units in the specified unit type.
Adds a unit to this .
The Unit to add.
The sum of unit1 and this Unit in this Unit's
type.
Subtracts a unit from this
.
The Unit to subtract.
The difference of this Unit and unit1 in this
Unit's type.
Multiplies this by a
specified value.
A double value to multiply by.
The product of multiplying this Unit by the specified
value.
Divides this by a
specified value.
A double value to divide by.
The quotient resulting by dividing this Unit by the
specified value.
Divides this by another.
A Unit value to divide by.
The quotient resulting by dividing this Unit by the
specified Unit.
Adds one to another.
The first Unit.
The second Unit.
The sum of the two units.
If unit1 is empty the method returns unit2. If
unit2 is empty the method returns unit1. Otherwise,
the method returns the sum of the two units in unit1's type.
Subtract one from
another.
The Unit to subtract from.
The Unit to subtract.
The difference of the two units.
Thrown when unit1 is empty.
If unit2 is empty the method returns unit1.
Otherwise, the method returns the difference of the two units
in unit1's type.
Unary minus. Reverses the sign of
The unit to negate.
A Unit of the same type as unit but with opposite
sign.
Multiplies a by a
specified value.
The Unit to multiply.
A double value to multiply by.
The product of unit1 and value.
Multiplies a value by a
.
The double value to multiply.
The Unit to multiply by.
A Unit that is the product of value and unit1.
Divides a by a
specified value.
The Unit to divide.
A double value to divide by.
A Unit that is the quotient of unit1 and
value.
Divides the first by the second.
A to divide.
A to divide by.
The quotient resulting by dividing of two Units.
Compares two units.
The first unit to compare.
The second unit to compare.
true if unit1 is less than unit2; otherwise
false.
Compares two units.
The first unit to compare.
The second unit to compare.
true if unit1 is greater than unit2; otherwise
false.
Compares two units.
The first unit to compare.
The second unit to compare.
true if unit1 is less than or equal to unit2;
otherwise false.
Compares two units.
The first unit to compare.
The second unit to compare.
true if unit1 is greater than or equal to
unit2; otherwise false.
Compares two units.
The first unit to compare.
The second unit to compare.
true if unit1 is equal to unit2; otherwise false.
Compares two units.
The first unit to compare.
The second unit to compare.
true if unit1 is not equal to unit2; otherwise
false.
Returns a hash code for this
structure.
An integer value that specifies a hash value for this
Unit structure.
Tests whether obj is a
that equals this
Unit.
The to test.
This method returns true if obj is a
Unit and its magnitude is equal to this Unit's
magnitude; otherwise false.
Returns the larger of two units.
The first of two units to compare.
The second of two units to compare.
Parameter val1 or val2, whichever is larger.
Returns the smaller of two units.
The first of two units to compare.
The second of two units to compare.
Parameter val1 or val2, whichever is smaller.
Returns a human-readable representation of this
.
A human-readable representation of this
.
Returns a human-readable representation of this
.
A specifying the
culture to use.
A human-readable representation of this
.
Gets or sets a
representing the default units of measure for a
.
A value
that defines the default units of measure for a Report.
Gets a double value representing the dpi of the current graphics
context.
A double value representing the dpi of the current graphics
context.
Specifies whether this
structure is uninitialized.
This property returns true if this unit is uninitialized;
otherwise, false.
Gets the type of the Unit.
A specifying the
type of this Unit.
Gets the magnitude of this Unit.
A float value indicating the magnitude of the Unit.
This property makes sense only in combination with the
property.
Gets the magnitude of this Unit in pixels.
An int value specifying the unit's magnitude in pixels.
Gets or sets the magnitude of this Unit in pixels.
A float value specifying the unit's magnitude in pixels.
Returns a magnitude in pixels based on the specified value
and type.
A double value specifying the magnitude.
A specifying the
unit type.
A double value representing the magnitude in pixels.
Returns a magnitude in units based on the specified pixels
and type.
A double value specifying the magnitude in pixels.
A specifying the
unit type to convert to.
A double value representing the magnitude in the specified
units.
Represents the type of a .
1 inch = 6 picas = 72 points.
1 centimeter = 10 millimeters.
Pixels convert to and from other units based on the dpi of the current
graphics context.
Represents pixels. String equivalent used in Unit's
constructor should be "px".
Represents points. String equivalent used in Unit's
constructor should be "pt".
Represents picas. String equivalent used in Unit's
constructor should be "pc".
Represents inches. String equivalent used in Unit's
constructor should be "in".
Represents millimeters. String equivalent used in Unit's
constructor should be "mm".
Represents centimeters. String equivalent used in Unit's
constructor should be "cm".
Specifies the vertical alignment of an object or text in an report item.
Specifies that the object is aligned to the top.
Specifies that the object is aligned to the middle.
Specifies that the object is aligned to the bottom.
Represents a collection of watermarks on a printable page.
Defines the orientation of the watermark text on the printable page.
The watermark text is oriented horizontally on the printable page.
The watermark text is oriented vertically on the printable page.
The watermark text is oriented diagonally on the printable page.
Defines the position of the watermark relative to the other items on the printable page.
Specifies that the watermark is behind the other items on the printable page.
Specifies that the watermark is in front of the other items on the printable page.
Defines the sizing mode of the watermark image on the printable page.
The watermark image is centered on the printable area of the page.
The watermark image is stretched to fill the printable area of the
page without preserving its original proportions.
The watermark image is scaled to fill the printable area of the
page while preserving its original proportions.
Represents an axis in a .
Occurs when the report item is disposed.
Gets or sets the scale for the current axis.
The scale can be one of the following types: , , , .
Gets the default style for the current axis, tick marks and labels.
Gets the default style for the title of the current axis.
Gets the style of the grid lines that correspond to the major axis steps.
Gets the style of the grid lines that correspond to the minor axis steps.
Gets or sets a value that indicates how to display the tick marks that correspond to the major axis steps.
Gets or sets a value that indicates how to display the tick marks that correspond to the minor axis steps.
Gets or sets a value that indicates how to format the labels.
Gets or sets the position of the axis labels according to the complementary axis' min/max values.
Gets or sets the angle in degrees at which the axis labels are rotated.
Gets or sets the title of the axis.
A started with "=" is interpreted as
an expression to calculate the real data,
otherwise - literal string.
Supports embedded expressions also.
Gets or sets the placement of the axis title.
Specifies the graph item's left position.
Specifies the graph item's left position.
Specifies the graph item's left position.
Gets or sets a value indicating whether to display multidimensional category scale labels on one or more levels.
Specifies how axis labels are placed on the axis.
No axis labels.
Follows the axis.
Labels at min value of the related axis.
Labels at max value of the related axis.
Specifies how tick marks are drawn on the axis.
No tick marks.
Display the tick marks inside the graph area.
Display the tick marks outside the graph area.
Display the tick marks so that it crosses the axis line, displaying both inside and outside the graph area.
Specifies how the axis title is placed on the axis.
No axis title.
Uses the default value for the axis title placement.
The axis title is placed at min value of the axis.
The axis title is placed at max value of the axis.
The axis title is centered according to the axis.
The orientation of the angular axis labels.
Labels are arranged in circle.
The angle of the data-point is the base angle for the label.
Additionally the LabelAngle property of the axis is taken into account.
The overall angle of the label is [data-point angle] + [LabelAngle]
Labels are arranged at a fixed angle.
All labels will have the same angle equal to the value of the LabelAngle property of the axis.
Represents a two-dimensional Cartesian (rectangular) coordinate system.
Represents a coordinate system in a item.
In the item
Represents an object of the report/data hierarchy. Used for the expand/collabse/cache data logic
that needs unique names/path. All items/objects that form the data hierarchy should implement this
interface.
Gets or sets the name of the coordinate system.
The Name should uniquely identify the coordinate system in the context
of the item it belongs to.
Gets the default style for the axes, tick marks and labels.
Gets the collection of binding rules contained within the report item.
An collection of instances
representing the list of property bindings defined within the item.
Gets or sets the X-axis (horizontal) of the CartesianCoordinateSystem.
Gets or sets the Y-axis (vertical) of the CartesianCoordinateSystem.
Represents a collection of objects.
Represents a two-dimensional polar coordinate system. Points in the polar coordinate
system are defined with radial and angular coordinates.
Gets or sets the radial axis of the PolarCoordinateSystem.
Gets or sets the angular axis of the PolarCoordinateSystem.
Gets or sets the orientation of the angular axis labels.
Gets or sets the angle in degrees measured clockwise from the radial axis to the starting point of the angular axis.
Gets or sets the angle in degrees measured clockwise from the startAngle parameter to ending point of the angular axis.
Gets or sets a value indicating the ratio between the inner and the outer radius of the PolarCoordinateSystem.
Use InnerRadiusRatio greater than 0 to create 'doughnut' like graphs.
Specifies how tick marks are positioned in relation to the data points.
Specifies data points to be positioned between tick marks.
Specifies data points to be positioned on tick marks.
Specifies a category scale for a .
Indicates whether to arrange values in reverse order.
Zero value is where the other axis crosses the current axis;
Determines the number of space slots that will be left around the DataPoints per category slot,
measured relatively to the DataPoint slot's width:
Empty Space = SpacingSlotCount * DataPoint_SlotWidth
Specifies how the tick marks are positioned in relation to data points.
Applied when GraphScaleCrossAxisPosition is set to GraphAxisZeroValueMode.Specific.
Zero value is where the other axis crosses the current axis.
Represents the position on an axis with where the axes cross.
Represents the position on an axis where the axes cross.
Gets or sets the value that indicates the position where the axes cross.
Gets or sets the value where the other axis crosses the current axis.
The Value property is applied only if is set to GraphAxisZeroValueMode.Specific.
Represents a collection of objects.
A DateTimeAxis displays dates in chronological order at specific intervals, or base units,
even if the dates from the data source are not in order or in the same base units.
Gets or sets the base unit for the current DateTimeScale. The base unit
defines the interval between the points on the axis. By default the base units
are according to the smallest difference between any two dates in the data.
Gets or sets the unit for the interval/step between the minor ticks/grid lines.
In conjunction with the property defines the interval between
the minor ticks and minor grid lines, ex.: 1 day, 3 months, 1 year.
Gets or sets the step/interval for the minor ticks/grid lines.
In conjunction with the property defines the interval between
the minor ticks and minor grid lines, ex.: 1 day, 3 months, 1 year.
Gets or sets the unit for the interval/step between the major ticks/grid lines.
In conjunction with the property defines the interval between
the major ticks and major grid lines, ex.: 1 day, 3 months, 1 year.
Gets or sets the step/interval between the major ticks/grid lines.
In conjunction with the property defines the interval between
the major ticks and major grid lines, ex.: 1 day, 3 months, 1 year.
Gets or sets the unit for the interval/step between the labels.
In conjunction with the property defines the interval between
the labels on the axis, ex.: 1 day, 3 months, 1 year.
Gets or sets the step/interval between the labels.
In conjunction with the property defines the interval between
the labels on the axis, ex.: 1 day, 3 months, 1 year. The property is applied only when
is set to a value other than Auto.
Gets or sets the minimum value for the current axis.
A DateTime value that is the minimum value of the scale's range. The default value is null.
When the Minimum property is set to null (Nothing in Visual Basic) then the minimum value of the scale's range is defined by the data.
In case there are no data points available then the Minimum value is set according to and the selected .
In case the Maximum and Minimum values are set to an equal value, then their values are ignored.
Gets or sets the maximum value for the current axis.
A DateTime value that is the maximum value of the scale's range. The default value is null.
When the Maximum property is set to null (Nothing in Visual Basic) then the maximum value of the scale's range is defined by the data.
In case there are no data points available then the Maximum value is set according to and the selected .
In case the Maximum and Minimum values are set to an equal value, then their values are ignored.
Applied when GraphScaleCrossAxisPosition is set to GraphAxisZeroValueMode.Specific.
Zero value is where the other axis crosses the current axis.
Gets or sets a value indicating weather to shows ticks and labels on the axis
for every point in the data set instead of regular major ticks.
Represents the position on an axis with where the axes cross.
Gets or sets the value where the other axis crosses the current axis.
The Value property is applied only if is set to GraphAxisZeroValueMode.Specific.
Represents a collection of objects.
Determines the unit for the interval/step between minor/major ticks/grid lines.
Specifies a seconds unit for the datetime interval.
Specifies a minute unit for the datetime interval.
Specifies an hour unit for the datetime interval.
Specifies a day unit for the datetime interval.
Specifies a month unit for the datetime interval.
Specifies a year unit for the datetime interval.
Determines the position at which axes cross each other.
Uses the default value at which the other axis crosses this axis.
Specifies that the other axis crosses this axis at its minimum value.
Specifies that the other axes crosses this axis at its maximum value.
Calculates the zero value at which the other axis crosses this axis.
The LogarithmicScale is similar to the , except there's a logarithmic transform that is
applied to the input domain value before the output range value is computed. The mapping
to the output range value y can be expressed as a function of the input domain
value x: y = m log(x) + b. The LogarithmicScale does not support zero or negative values.
The base class for all numerical scales.
Axis' minimum value. Set to float.NaN to automatically calculate the value based on the data.
Graph axis range - maximum value. Set to float.NaN to automatically calculate the value based on the data.
Gets or sets a value indicating weather to shows ticks and labels on the axis
for every point in the data set instead of regular major ticks.
Gets or sets the base value of the logarithm.
Axis' minimum value. Set to float.NaN to automatically calculate the value based on the data.
Due to the nature of the logarithmic transformation applied to the scale
the Minimum property accepts only positive numbers and
throws an error for zero or negative values.
A positive number that defines the minimum value for the scale.
A value indicates that the scale will automatically
calculate its minimum value based on the data.
The default value is .
Graph axis range - maximum value. Set to float.NaN to automatically calculate the value based on the data.
Due to the nature of the logarithmic transformation applied to the scale the Maximum property accepts only positive numbers and
throws an error for zero or negative values.
A positive number that indicates the maximum value for the scale.
A positive number that defines the maximum value for the scale.
A value indicates that the scale will automatically
calculate its maximum value based on the data.
The default value is .
[MergableProperty(true)]
A collection of items that defines
the where the other axes cross the current one.
Gets or sets the step/interval for the major ticks/grid lines.
Gets or sets the step/interval for the minor ticks/grid lines.
Applied when GraphScaleCrossAxisPosition is set to GraphAxisZeroValueMode.Specific.
Zero value is where the other axis crosses the current axis.
Represents the position on an axis with where the axes cross.
Gets or sets the value where the other axis crosses the current axis.
The Value property is applied only if is set to GraphAxisZeroValueMode.Specific.
Due to the nature of the logarithmic transformation applied to the scale
the Value property accepts only positive numbers and
throws an error for zero or negative values.
A positive number that defines the exact value where the other axis crosses the current one.
The default value is 1.0.
Represents a collection of objects.
Represents a numerical scale with continuous input domain.
Gets or sets the step/interval for the major ticks/grid lines.
Gets or sets the step/interval for the minor ticks/grid lines.
Gets or sets the step/interval for the labels on the axis.
Applied when GraphScaleCrossAxisPosition is set to GraphAxisZeroValueMode.Specific.
Zero value is where the other axis crosses the current axis.
A collection of items that defines
the where the other axes cross the current one.
Represents the position on an axis with where the axes cross.
Gets or sets the value where the other axis crosses the current axis.
The Value property is applied only if is set to GraphAxisZeroValueMode.Specific.
Represents a collection of objects.
Represents an area chart displays a series as a set of points connected by a line, with all the area filled in below the line
Represents a series of data points in a two-dimensional coordinate system.
Represents a series of data points with labels in the report item.
Represents a series of data points with labels in the and report items.
Data point label.
A started with "=" is interpreted as
an expression to calculate the real data,
otherwise - literal string.
Supports embedded expressions also.
Gets or sets the angle in degrees at which the data point labels are rotated.
Data point label format.
Gets the style for the labels of the data points.
Gets the to applied on the data points' labels.
Reserved for future use
Data point tooltip
A started with "=" is interpreted as
an expression to calculate the real data,
otherwise - literal string.
Supports embedded expressions also.
Reserved for future use
Data point tooltip format
Gets the to applied on the data points.
Gets the default style of a data point.
Gets or sets an expression or a text which is displayed in the legend.
A started with "=" is interpreted as
an expression to calculate the real data,
otherwise - literal string.
Supports embedded expressions also.
Gets or sets the number format for the legend value.
Gets or sets the for the current GraphSeries
Gets or sets the name of the graph series.
The name of the graph series.
Gets or sets the color palette used for graph series.
A implementation
representing color palette used for graph series.
Gets or sets the axis/direction that the is applied to.
This property is applicable if the ArrangeMode is set to Stacked or Stacked100; otherwise it is ignored.
Use the ArrangeByAxis property to specify how the series will be arranged (stacked) at runtime.
By default the Graph item always stacks the series by the axis with the Numeric scale
(including LogarithmicScale and ExponentialScale).
If a series is to be projected on a coordinate system with a combination of
NumericScale/CategoryScale or NumericScale/DateTimeScale, and the series has an
ArrangeMode set to Stacked or Stacked100, the series will always be stacked
by the value projected on the NumericScale, no matter if this is X/Y/Angular or Radial axis.
In the case a series is to be projected on a coordinate system where both axes
are NumercScales you can choose how you want to stack the series’ values.
If no axis is specified, the default is the X axis (in CartesianCoordinateSytem)
or the Angular axis (in the case of PolarCooordinateSystem).
The coordinate system to project the data points (category/value) onto.
The coordinate system can be a or a .
Gets or sets the from the
hierarchy associated with this series.
Gets or sets the from the
hierarchy associated with this series.
Gets or sets an expression that defines the X coordinate for the data points when in a
; For a gets or sets
the the Angular coordinate;
Gets or sets an expression that defines the Y coordinate for the data points when in a
; For a gets or sets
the the Radial coordinate;
Gets or sets a value indicating how to arrange the series at runtime.
Gets the rules which are applied on the series' style.
Gets the style applied to the area defined by the the data points of this series.
Gets or sets a value indicating how to connect the data points: with a smooth or
straight lines.
When the SmoothLine is enabled the data points are connected with Bezier curves.
Gets or sets a value indicating how to connect the data points: with smooth,
straight or stepped lines.
Gets or sets the type of the markers for the data points.
Gets or sets the size of the markers for the data points.
Gets or sets an expression that defines the X0 coordinate for the data points when in a
; For gets or sets
the the angular coordinate;
If omitted, the BarSeries' data points start from the corresponding axis.
Gets or sets an expression that defines the Y0 coordinate for the data points when in a
; For gets or sets
the the radial coordinate;
If omitted, the BarSeries' data points start from the corresponding axis.
Specifies how to align the labels for the data points of the .
Labels outside the end of each data point.
Labels inside the end of each data point.
Labels in the middle of each data point.
Labels inside the base of each data point.
Labels outside the base of each data point.
Labels aligned in a column outside the farthest end of the data points. Applicable to PieCharts.
Represents a series of data points with rectangular (Bar) shape when projected on a .
For the the items of the BarSeries have a wedge shape like in a
Pie or Doughnut charts.
Creates an instance of the class.
Specifies the data point label alignment.
Gets or sets the DataPointLabel offset, according the DataPointLabelPosition.
Gets the style for the data point label connectors.
Gets the to be applied on the data points' label connectors.
Gets or sets an expression that defines the X0 coordinate for the data points when in a
; For gets or sets
the the angular coordinate;
If omitted, the BarSeries' data points start from the corresponding axis.
Gets or sets an expression that defines the Y0 coordinate for the data points when in a
; For gets or sets
the the radial coordinate;
If omitted, the BarSeries' data points start from the corresponding axis.
Determines the data point markers.
Uses the default marker type.
Uses a square shape for the data point marker.
Uses a diamond shape for the data point marker.
Uses a circle shape for the data point marker.
Uses a triangle shape for the data point marker.
Uses an X shape for the data point marker.
Uses a '+' shape for the data point marker.
Uses a '-' shape for the data point marker.
Specifies how the the graph series are arranged according to each other.
Specifies that the series are overlapped.
Specifies that the graph series are clustered. This value is applicable to Bar/Column charts only.
Specifies that the graph series are stacked.
Specifies that the graph series are stacked so that the data points from different series show a relative to each other value.
Represents a collection of objects.
Specifies the legend for the graph series.
Gets the collection of the conditional formatting rules, associated with the item's style.
Gets the collection of the conditional formatting rules, associated with the mark style.
Gets or sets the format for the legend value.
Specifies the text or expression which is displayed in the legend
Specifies the legend item's style.
Specifies the legend item's mark style.
Specifies how to align the labels for the data points of the scatter series: .
Labels on the left of each data point.
Labels on the right of each data point.
Labels above each data point.
Labels below each data point.
Labels in the middle of each data point.
Represents a in which the data points are connected with a line.
Creates an instance of the .
Gets the rules which are applied on the series' style.
Gets or sets an expression that defines the size of the markers. Use this property to
create a Bubble like charts.
Gets or sets a value that defines the minimum size of the markers. Use this property to
create a Bubble like charts.
The minimum size of the markers/bubbles.
Set to for the value to be defined at run time according to the data.
The default value is .
Gets or sets a value that defines the maximum size of the markers. Use this property to
create a Bubble like charts.
The maximum size of the markers/bubbles.
Set to for the value to be defined at run time according to the data.
The default value is .
Gets or sets a value indicating how to connect the data points: with a smooth or
straight lines.
When the SmoothLine is enabled the data points are connected with Bezier curves.
Gets or sets a value indicating how to connect the data points: with smooth,
straight or stepped lines.
Gets the style applied to the line that connects the data points of this series.
Gets or sets the shape of the marker.
Gets or sets the size of the markers if no is specified;
Gets or sets the size of the markers for the minimum value of the property.
Use the MarkerMinSize and properties in conjunction with the property
to create a Bubble chart;
Gets or sets the size for the maximum value of the property.
Use the MarkerMinSize and properties in conjunction with the property
to create a Bubble chart;
Gets or sets a value indicating how the labels of the data points to be aligned.
Gets or sets the DataPointLabel offset, according the DataPointLabelPosition.
Represents an with both start (X0, Y0) and end (Y, Y) values.
Represents a with both start (X0, Y0) and end (Y, Y) values.
Use the Graph item to add charts to a report.
Defines the base class for all report items that can be placed in a
. Items of this type
have a location and a size.
Defines the base class for visual report items used for creating
reports.
Represents a report object which may be used as target of a .
Gets the name of the report object used as toggle visibility target.
The name of the report object.
The Name of the toggle visibility target should be unique in the report scope so
that triggering the toggle visibility action does not interfere with other report objects.
Gets or sets the color.
Gets or sets the bold.
Gets or sets the italic.
Gets or sets the name.
Gets or sets the size.
The size.
Gets or sets the strikeout.
Gets or sets the underline.
Gets or sets the background color.
Gets or sets the text style with StyleBuilder.
Returns a that represents the current
.
A String that contains the Name and the Type's
FullName of the current
.
Retrieves a value indicating whether the specified report item is
a child of the report item.
true if the specified report item is a child of the report
item; otherwise, false.
The to evaluate.
Raises the
event.
Raises the
event.
Raises the
event.
The being added.
Raises the
event.
The being removed.
Indicates whether this item can add the specified item as a
child.
The item to check.
true if the specified item can be a
added to this item, otherwise false.
The CanAdd method checks two conditions
Indicates whether an object of the specified type can be a
direct child of this item.
The type to check.
true if an object of the specified type can
be a direct child of this item, otherwise false.
If an item cannot contain an object of a given type, then it cannot
parent it as well. If an item cannot parent an object of a given
type, this does not mean that it cannot contain it. For example, a
Report cannot directly parent a TextBox, but it can contain a
TextBox.
Indicates whether this item can contain an object of the specified
type.
The type to check.
true if this item can contain an object of the
specified type, otherwise false.
Indicates whether this can be an ancestor of the specified item.
THIS OBJECT CAN BE AN ANCESTOR OF THE SPECIFIED ITEM WHEN IT CAN
CONTAIN THE TYPE OF THE ITEM AND ALL OF ITS DESCENDANTS.
The
to check.
true if this can be an ancestor of the specified
item, otherwise false.
Invalid ancestor-descendant relationships may occur even if the
direct parent-child relation (as indicated by the CanParent method)
is OK, but the item hierarchy as a whole is not OK (as indicated by
the CanContain method).
For example, a PageSection can have a Panel as a direct child and a
Panel can have a SubReport as a direct child (as indicated by the
CanParent method), but if we add a Panel with a SubReport in it to
a PageSection we will break the rule that PageSections cannot be
ancestors of SubReports (CanContain method).
Applies the specified
s to this item.
The s to apply to
this instance.
A value indicating whether to apply the
style to the children of this item recursively.
Design time purposes only
Occurs when a new report item is added to the
.
Occurs when a report item is removed from the
.
Occurs when the report item binds to a data source.
Occurs after the report item binds to a data source.
Occurs when the report item is disposed.
Gets or sets the name of the report item.
The name of the report item.
The Name property can be used at run time to evaluate the
object by name rather than type and programmatic name.
Gets or sets a value indicating whether the report item is
displayed.
true if the report item is displayed; otherwise,
false. The default is true.
Gets or sets the name of the report item's global style.
A string value specifying the style name.
Global styles are defined through the
's
property.
Gets a object
specifying the appearance of the report item.
A object specifying
the items's style.
Gets the collection of report items contained within the report
item.
An
representing the collection of items contained within the item.
Gets or sets the parent container of the report item.
A that represents
the parent item of the report item.
Setting the Parent property value to a null reference
(Nothing in Visual Basic) removes the item from the
of
its current parent item.
Gets the report this item belongs to.
A object which the item
belongs to.
Gets the collection of the conditional formatting rules, associated with this item.
Gets or sets a bookmark label to be displayed for this report item.
A string / expression value specifying the bookmark label.
Gets or sets a bookmark id for this item.
A started with "=" is interpreted as
an expression to calculate the real data,
otherwise - literal string.
Supports embedded expressions also.
When processed should evaluate to an unique value
for each processing instance of the item.
Gets or sets a text to be displayed for this item in the document map.
When defined the document map displays nodes
that navigate to the instances of the item.
A started with "=" is interpreted as
an expression to calculate the real data,
otherwise - literal string.
Supports embedded expressions also.
Gets or sets an interactive action associated with this report item.
Gets the collection of binding rules contained within the report item.
An collection of instances
representing the list of property bindings defined within the item.
Represents a collection of
objects.
The ,
,
and
methods enable you to add and remove individual items from the
collection. You can also use the
or methods
to add or remove all the items from the collection.
You can determine if a
is a member of the
collection by passing the item into the
method. To get the index value of the location of a
in the collection,
pass the item into the
method. The collection can be copied into an array by calling the
method.
Initializes a new instance of the
class.
A representing
the report item that owns the report item collection.
Adds an array of report item objects to the collection.
An array of
objects to add to the collection.
The ReportItemBase objects contained in the
items array are appended to the end of the collection.
You can use the AddRange method to quickly add a
group of ReportItemBase objects to the collection
instead of manually adding each ReportItemBase to the
collection using the
method.
To remove a ReportItemBase that you previously
added, use the
,
,
or
methods.
Removes the child report item with the specified key.
The name of the child report item to remove.
The
property of a
corresponds to the key for a ReportItemBase in the
.
Determines whether the ReportItemBase.ItemCollection
contains an item with the specified key.
The key to locate in the
.
true if the ReportItemBase.ItemCollection
contains an item with the specified key; otherwise,
false.
The
property of a
corresponds to the key for a ReportItemBase in the
.
Gets a value indicating whether the specified index exists in
the collection.
An index value to check.
true if the collection contains an item with the
specified index; otherwise false.
Retrieves the index of the first occurrence of the specified
item within the collection.
The name of the report item to search for.
The zero-based index of the first occurrence of the report item
with the specified name in the collection.
The key comparison is not case-sensitive. If the key
parameter is a null reference (Nothing in Visual Basic) or an
empty string, or an item with the specified key is not found,
IndexOfKey returns -1.
The
property of a
corresponds to the key for a ReportItemBase in the
.
Performs additional custom processes when validating a value.
The object to validate.
The object is not an instance of the
class or one of
its derived classes.
Overrides the
method.
The zero-based index at which to insert value.
The new value of the element at index.
Overrides the
method.
The zero-based index at which value can be found.
The value of the element to remove from index.
Searches for report items by their
property and builds an array of all the report items that
match.
The key to locate in the
.
true to search all child report items; otherwise,
false.
An array of type
containing the
matching report items.
The key parameter is null or empty.
Searches the collection for a report item of the specified
type.
The to search for.
The first in
the collection that matches the given
. If no item in the collection
matches the given the method returns
null.
Searches for report items by their Type and builds an array of
all the items that match.
The to search for.
An array of type
containing the
matching report items.
Searches for report items by their Type and builds an array of
all the items that match.
The to search for.
A value indicating whether to search
all children recursively.
An array of type
containing the
matching report items.
Retrieves the index of a report item within the item
collection.
The to search
for in the item collection.
A zero-based index value that represents the location of the
specified child report item within the item collection.
Retrieves the index of the specified child report item within
the item collection, and optionally raises an exception if the
specified report item is not within the item collection.
The to search
for in the item collection.
true to throw an exception if the ReportItemBase
specified in the child parameter is not an item in the
;
otherwise, false.
A zero-based index value that represents the location of the
specified child report item within the item collection;
otherwise -1 if the specified ReportItemBase is not
found in the
.
The child is not contained in the collection and the
throwException parameter is true.
Returns the with
the specified key in the collection.
The name of the report item to retrieve from the report item
collection.
The with the
specified key in the collection.
Gets or sets the height and width of the report item.
The that represents
the height and width of the report item in Units.
Because the SizeU class is a value type (Structure in
Visual Basic, struct in Visual C#), it is returned by value,
meaning accessing the property returns a copy of the size of the
report item. So, adjusting the
or
properties of
the SizeU returned from this property will not affect the
or
of the report
item. To adjust the Width or Height of the report
item, you must set the item's Width or Height
property, or set the Size property with a new SizeU.
Gets or sets the coordinates of the upper-left corner of the report
item relative to the upper-left corner of its container.
The that represents
the upper-left corner of the report item relative to the upper-left
corner of its container.
Because the PointU class is a value type (Structure
in Visual Basic, struct in Visual C#), it is returned by
value, meaning accessing the property returns a copy of the
upper-left point of the report item. So, adjusting the
or
properties of the
PointU returned from this property will not affect the
,
,
, or
property values
of the report item. To adjust these properties set each property
value individually, or set the Location property with a new
PointU.
Gets or sets the edges of the container to which a report is bound
and determines how a report items is resized with its parent.
A bitwise combination of the
values. The default
is .
Use the Anchoring property to define how a report is automatically
resized as its parent item is resized. Anchoring a report to its
parent ensures that the anchored edges remain in the same position
relative to the edges of the parent when the parent control is
resized.
You can anchor a report item to one or more edges of its
container. For example, if you have a DetailSection with a
TextBox whose Anchoring property value is set to
Top and Bottom, the TextBox is stretched to
maintain the anchored distance to the top and bottom edges of the
DetailSection as the Height of the
DetailSection is increased.
Note:The Anchoring and
properties are
mutually exclusive. Only one can be set at a time, and the last one
set takes precedence.
Gets or sets which report item borders are docked to its parent
and determines how a report item is resized with its parent.
One of the values.
The default is .
Use the Docking property to define how a report is
automatically resized as its parent is resized. For example,
setting Docking to
causes the report
item to align itself with the bottom edges of its parent and to
resize as the parent is resized.
A report item can be docked to one edge of its parent container or
can be docked to all edges and fill the parent container.
Note:The
and Docking properties are mutually exclusive. Only one can be
set at a time, and the last one set takes precedence.
Gets or sets the size and location of the report item including its
nonclient elements, in Units, relative to the parent report item.
A relative to
the parent report item that represents the size and location of the
report item including its nonclient elements.
The bounds of the report item include the nonclient elements such
as borders and padding.
Gets or sets the distance, in Units, between the left edge of the
report item and the left edge of its container's client area.
An representing the
distance between the left edge of the report item and the left edge
of its container's client area.
The Left property value is equivalent to the
property of the
property value
of the report item.
Changes made to the
and Left
property values cause the
property value of
the report item to change.
Gets the distance, in Units, between the right edge of the
report item and the left edge of its container's client area.
An representing the
distance between the right edge of the report item and the left edge
of its container's client area.
The value of the Right property is equal to the sum of the
property value and
the property
value.
Gets or sets the distance, in Units, between the top edge of the
report item and the top edge of its container's client area.
An representing the
distance between the top edge of the report item and the top edge
of its container's client area.
The Top property value is equivalent to the
property of the
property value
of the report item.
Changes made to the
and Top
property values cause the
property value of
the report item to change.
Gets the distance, in Units, between the bottom edge of the
report item and the top edge of its container's client area.
An representing the
distance between the bottom edge of the report item and the top
edge of its container's client area.
The value of the Bottom property is equal to the sum of the
property value and
the property
value.
Gets or sets the width of the report item.
The width of the report item in Units.
Changes made to the Width and
property values
cause the property
value of the report item to change.
Gets or sets the height of the report item.
The height of the report item in Units.
Changes made to the Height and
property values
cause the property
value of the report item to change.
Gets the default size of the report item.
The default of the
report item.
The DefaultSize property represents the SizeU of the
report item when it is initially created. You can adjust the size
of the report item by setting its
property value.
Defines an interface for data-bound items.
Occurs when the processing of the data item processing instance (i.e., instance) begins
and this instance has no property set.
The event is hooked on the definition instance,
but the sender object in the event handler is the processing instance.
The processing instance of the data item inherits its DataSource from the definition instance,
but if neither has DataSource set, this event is raised.
The following example demonstrates how to implement a NeedDataSource event handler:
- A
- A
- A
- A
- Any component that implements the
interface
- Any component that implements the
interface
- Any component that implements the
interface
If the DataSource reference contains more than one table,
you must set the DataMember property a string that specifies
the table to bind to. For example, if the DataSource is a
DataSet or DataViewManager that contains three tables
named Customers, Orders, and
OrderDetails, you must specify the table to bind to.
Setting the DataSource to an object that does not implement
the IListSource, IEnumerable, or IDataAdapter
will cause an exception.
Gets a
that defines the filter expression(s) for the
that contains the
objects for
the Table
Filter expressions limit the data that is displayed to the user
after the data is retrieved from the data source.
Gets or sets the current data item no data message.
A that starts with "=" is interpreted as expression
to calculate the no data message;
otherwise - literal string.
Supports embedded expressions also.
Gets a object
specifying the appearance of the no data message.
A object specifying
the items's style.
Gets a
that defines the sort column(s), and their type and order for the
A
that contains the
objects for the
Table
Sort expressions sort the data that is displayed to the user
after the data is retrieved from the data source.
Gets the collection of s.
Gets the hierarchy of s that define the series for the current Graph.
Gets the hierarchy of s that define the categories for the current Graph.
Gets the collection of defined for the current Graph.
Gets the Legend for the current Graph
Gets the collection of defined for the current Graph.
Gets the style of the plot area.
The plot area of a Graph is the area where all series including the data points
and labels are rendered. The plot area also contains all grid lines if defined.
Gets or sets the culture information associated with the Graph item.
A representing the
culture supported by the .
Gets or sets the color palette used for graph series.
A implementation
representing color palette used for graph series.
Represents a group in a item.
Represents an interface for grouping, filtering and sorting data.
Gets or sets the name of the group.
The name of the group.
The Name property can be used at run time to set the scope of aggregate functions.
Gets a
object that holds all
objects for
the group.
A
value containing the group expressions of the group.
Groups are defined by adding one or more group expressions to the
collection. Grouping can be done by one or more data fields. Each
data field is represented by a group expression in the collection.
Gets a
that defines the sort column(s), and their type and order for the
Group
A
that contains the
objects for the
Group
Sort expressions sort the data that is displayed in the
Group
Gets a
that defines the filter expression(s) for the
A
that contains the
objects for
the Group
Filter expressions limit the data that is displayed in the
Group
Defines hierarchy of groups
Gets or sets the label for the categories in category axis.
Applicable only to groups from the hierarchy.
A started with "=" is interpreted as
an expression to calculate the real data,
otherwise - literal string.
Supports embedded expressions also.
Gets or sets an interactive action associated with this graph group.
Gets or sets a value indicating whether the graph group is displayed.
true if the table group is displayed; otherwise,
false. The default is true.
Represents a collection of s.
Specifies the graph item's bounds.
Specifies the graph item's location.
Specifies the graph item's size.
Specifies the graph item's top position.
Specifies the graph item's left position.
Specifies the graph item's width.
Specifies the graph item's height.
Specifies the graph item's style.
Determines whether the graph item is inside or outside the plot area.
Specifies the graph item's position.
Specifies top left position.
Specifies top center position.
Specifies top right position.
Specifies left top position.
Specifies left center position.
Specifies left bottom position.
Specifies right top position.
Specifies right center position.
Specifies right bottom position.
Specifies bottom left position.
Specifies bottom center position.
Specifies bottom right position.
Specifies absolute position.
Specifies center position.
Specifies the legend for the graph.
Specifies the text for the legend's title.
A started with "=" is interpreted as
an expression to calculate the real data,
otherwise - literal string.
Supports embedded expressions also.
Specifies the for the legend's title.
Specifies the position of the .
Represents a title for the graph.
Specifies the text for the title.
A started with "=" is interpreted as
an expression to calculate the real data,
otherwise - literal string.
Supports embedded expressions also.
Specifies the position of .
Represents a collection of objects.
Gets the spatial data for the from an ESRI Shapefile.
Specifies the source that the will use to obtain the spatial data.
Gets or sets the expression that defines the name of the shape file used to get the spatial coordinates for the data points.
Gets or sets the expressions that match the analytical data set fields to the spatial data fields.
Represents a group by a geographical location (usually region, country, city, etc.) in a item.
A base class for the groups of a report item.
Gets or sets a value indicating whether the Map group is displayed.
true if the table group is displayed; otherwise,
false. The default is true.
Gets or sets a value that represents the location of the data points.
In order a item to be able to resolve the actual geographic location a should be configured.
A started with "=" is interpreted as
an expression to calculate the real data,
otherwise - literal string.
Supports embedded expressions also.
A collection of GeoLocationMapGroups that defines the children of a GeoLocationMapGroup group.
A collection of GeoLocationMapGroups groups.
Represents a series group in a item.
Gets or sets an interactive action associated with this graph group.
A collection of MapGroupBase groups.
Represents a collection of s.
Represents a group used in a that allows to set a shape source type for any group instance.
A collection of ShapeFileMapGroups that defines the children of a ShapeFileMapGroup group.
A collection of GeoLocationMapGroups groups.
Gets the spatial data for the from an Well-known text string or its binary (WKB) representation.
Gets or sets an expression that defines the spatial coordinates for the data points.
A class used to match the addresses or locations with geographical coordinates (latitude and longitude) using the Bing™ Maps REST API. ///
Requires a valid Bing Maps Key that could be obtained from "http://www.microsoft.com/maps/create-a-bing-maps-key.aspx"
The more detailed information is used in the query, the more accurate the results will be.
For example, if you are looking for Vienna, Austria, you need to provide the country name as well, because otherwise the first returned result would be Vienna, VA, United States
Bing™ Maps geocoding service is able to determine the relation between the query arguments - i.e. the results will be the same if you search for either "Vienna, Austria" or "Austria, Vienna"
An abstract class for all the web-based location service providers
An abstract class for the location providers that can be used for geocoding.
Represents a common interface for all location providers used for geocoding.
Represents a common interface for all the web-based location service providers
The client token that authenticates the request.
The Url of the location server.
The client token that authenticates the request.
The Url of the location server
A class used to match the addresses or locations with geographical coordinates (latitude and longitude) using the MapQuest Licensed Geocoding API.
Requires a valid MapQuest AppKey that could be obtained from "http://developer.mapquest.com/web/products/open"
The more detailed information is used in the query, the more accurate the results will be.
For example, if you are looking for Vienna, Austria, you need to provide the country name as well, because otherwise the first returned result would be Vienna, GA, United States
Please note that the query arguments order is of a huge significance.
In the example above if you switch the query arguments to "Austria, Vienna", the service will return "Vienna, Dooly County, GA, USA"
A class used to match the addresses or locations with geographical coordinates (latitude and longitude) using the MapQuest Open Geocoding API Web Service: http://developer.mapquest.com/web/products/open/geocoding-service
Requires a valid MapQuest AppKey that could be obtained from "http://developer.mapquest.com/web/products/open"
The more detailed information is used in the query, the more accurate the results will be.
For example, if you are looking for Vienna, Austria, you need to provide the country name as well, because otherwise the first returned result would be Vienna, GA, United States
Please note that the query arguments order is of a huge significance.
In the example above if you switch the query arguments to "Austria, Vienna", the service will return "Vienna, Dooly County, GA, USA"
Interface describing the representation model used to project the globe or celestial sphere on a surface
A cylindrical map projection known also as Normal Mercator.
Represents a series of data points in the report item that displays embedded column charts as data points.
Represents a series of data points in the report item that displays embedded charts as data points.
Represents a series of data points in the report item that displays markers for the point location.
The base class for all the series that use to obtain the coordinates of their data points.
The base class for the series of data points with labels in the report item.
Gets or sets the from the
hierarchy associated with this series.
Gets or sets the from the
hierarchy associated with this series.
Gets or sets an expression that defines the Longitude coordinate for the data points.
Gets or sets an expression that defines the Latitude coordinate for the data points.
Gets or sets an expression that defines the size of the markers. Use this property to
create a Bubble like charts.
Gets or sets a value that defines the minimum size of the markers. Use this property to
create a Bubble like charts.
The minimum size of the markers/bubbles.
Set to for the value to be defined at run time according to the data.
The default value is .
Gets or sets a value that defines the maximum size of the markers. Use this property to
create a Bubble like charts.
The maximum size of the markers/bubbles.
Set to for the value to be defined at run time according to the data.
The default value is .
Gets or sets the size of the markers if no is specified;
Gets or sets the size of the markers for the minimum value of the property.
Use the MarkerMinSize and properties in conjunction with the property
to create a Bubble chart;
Gets or sets the size for the maximum value of the property.
Use the MarkerMinSize and properties in conjunction with the property
to create a Bubble chart;
Gets or sets the shape of the marker.
Gets or sets a value indicating how the labels of the data points to be aligned.
Gets or sets the DataPointLabel offset, according the DataPointLabelPosition.
Creates a new instance of ColumnMapSeries.
Represents a collection of objects.
Represents a series of data points in the report item that displays embedded pie charts as data points.
Creates a new instance of PieMapSeries.
///
Represents a series of data points in the report item that displays a shape defined by geographical coordinates.
Gets or sets the from the
hierarchy associated with this series.
Gets or sets an expression that defines the color field for the data points.
Gets or sets a value indicating how the labels of the data points to be aligned.
Gets or sets the DataPointLabel offset, according the DataPointLabelPosition.
Gets or sets the count of the colors that show the data ranges. The property is not respected when RangeGrouping is None.
Gets or sets the data points grouping in ranges.
Gets or sets the source type of the spatial data that will be used to get the coordinates for the data points.
Determines which algorithm will be used to split the data into groups.
The count of groups is determined by the ColorsCount property.
No grouping will be used.
The range between the minimum and maximum values will be divided by the group count, so every value will fall in a specific interval.
The processing engine will try to distribute the amount of data values evenly among the groups, assigning a group to each value in the range.
A class used to provide map tiles from the Bing™ Maps tile servers.
Requires a valid Bing Maps Key that could be obtained from "http://www.microsoft.com/maps/create-a-bing-maps-key.aspx"
The following example demonstrates how to initialize a BingMapsTileProvider instance:
- A
- A
- A
- A
- Any component that implements the
interface
- Any component that implements the
interface
- Any component that implements the
interface
If the DataSource reference contains more than one table,
you must set the DataMember property a string that specifies
the table to bind to. For example, if the DataSource is a
DataSet or DataViewManager that contains three tables
named Customers, Orders, and
OrderDetails, you must specify the table to bind to.
Setting the DataSource to an object that does not implement
the IListSource, IEnumerable, or IDataAdapter
will cause an exception.
Gets a
that defines the filter expression(s) for the
A
that contains the
objects for
the Report
Filter expressions limit the data that is displayed to the user
after the data is retrieved from the data source.
Gets a
that defines the sort column(s), and their type and order for the
A
that contains the
objects for the
Report
Sort expressions sort the data that is displayed to the user
after the data is retrieved from the data source.
Gets a
that defines the groups for the
A
that contains the
objects for the Report
Grouping is used to gather all rows that match certain grouping
criteria together. Grouping criteria is defined by adding one or
more objects
to a .
Gets or sets a representing the name
of the report document.
A representing the document name. The
default value is the name of the
this property belongs to.
The value of this property is used to suggest a file name when
exporting a report to one of the available export formats.
This property value is not used when exporting from the standalone report designer.
The report filename will be used instead.
Also used to specify the report name (root node) in the document map.
A that starts with "=" is interpreted
as an expression to evaluate the document name; otherwise it is
interpreted as a literal string. The expression cannot contain any data fields.
Gets or sets a
for the .
A representing
the page numbering style. The default value is
When the report is part of a
, use this property to
indicate whether the page numbering / count should start from 1 or continue
from the last page number / count of the previous report.
Represents a collection of
objects.
Represents a collection of reports logically unified as a single
document.
Initializes a new instance of the
class with default
settings.
Initializes a new instance of the
class from the provided
reports.
Initializes a new instance of the
class from the provided
reports and document name.
Gets the collection of reports that are parts of this ReportBook.
Gets the reports contained in the ReportBook.
Gets or sets a representing the name
of the document.
A representing the document name. The
default value is the Type name of the
this property belongs to.
The value of this property is used to suggest a file name when
exporting to one of the available export formats.
A that starts with "=" is interpreted
as an expression to evaluate the document name; otherwise it is
interpreted as a literal string.
For internal use only.
Gets the s of the
. Parameters are obtained
by merging the parameters of individual reports that have their
Mergeable property set to true plus adding all non-mergable
parameters.
Represents a base class for collection of objects.
Adds an enumerable of objects to the
.
An enumerable of objects to add to
the .
The objects returned from the
enumerable are appended to the end of the
.
Determines whether the
contains a report parameter with a specific name.
A that specifies the parameter name for which
to search the elements of the
.
Returns a value indicating whether the
object contains a report
parameter with the specified name.
Determines the index of a specific report parameter in the
.
The parameter name used to locate the report
parameter in the .
The index of report parameter if found in the
; otherwise, -1.
Gets a report parameter by name.
The name of the report parameter.
A report parameter if found; otherwise null (Nothing)
Represents a merged parameter, that is many identical parameters
represented by a single object. All child parameters should have the
same Name and Type, which effectively becomes the Name and Type of
the MergedReportParameter. The UI of the MergedReportParameter is
the UI of its FIRST child parameter.
Represents a collection of
objects.
Adds an array of report objects to the collection.
A collection of objects to add to
the current collection.
The Report objects contained in the items array are
appended to the end of the collection.
Represents a report footer section. Report footer is displayed at the
end of a report, but before the last
if any.
If you do not want a
displayed on the last page set the
property to false.
Gets or sets a value indicating whether the rendering engine should
print the section at the bottom of the page that contains the section.
A boolean value indicating whether the rendering engine should
print the section at the bottom of the page that contains the section.
When false, the section will be printed right after the preceeding
section. When true, the section will be printed at the bottom of the
page that contains the section. All subsequent sections will be moved
on the next page. If there is no preceeding section on the page,
the section will print on the top of the page.
Represents a report header section. Report header is displayed at the
beginning of a report, but after the first
if any.
If you do not want a
displayed on the first page set the
property to false.
Represents a report parameter.
Initializes a new instance of the class.
Initializes a new instance of the class.
Gets or sets the name of the parameter. Used to access the parameter.
Parameter names must be unique in the context of a single report.
The name must be a valid identifier - may contain only digits (0-9), letters (a-z, A-Z),
and underscore sign (_). Must begin with a letter or underscore.
Gets or sets the data type of the parameter.
Determines the type of the values. Acceptable values for each type are listed in .
The default parameter type is .
Gets or sets the value of the parameter. Can be an Expression that
evaluates to an object, value of the allowed types,
or containing values of the allowed types.
Gets or sets a value indicating whether this parameter should be
merged with identical parameters from other reports when this report
is part of a .
Controls parameter merging in .
The default value of the Mergeable property is true.
Set the Mergeable property to false if you want to prevent a parameter
from being merged with its equivalent ones.
Gets or sets the text for the parameter's automatic UI displayed in the report viewer.
Can be an Expression that evaluates to a string.
The Text property specifies the text for the parameter to be displayed
in the report viewer as prompt to the end user.
If value for the property is not provided the
of the parameter is used.
Determines whether automatic user interface (UI) prompting for values
to be generated for the parameter.
Specifies whether the parameter will have UI in the parameters area.
When at least one report parameter has the Visible property turned on,
a parameter area is shown as part of the report viewer.
If this property is set to false, the parameter must be populated
programmatically or at design time.
Determines if the parameter can hold more then one value.
If the value is set to true as a valid value of the parameter is accepted
or of values
of the specified of the parameter.
Parameters with MultiValue turned on are mainly used with the IN logical operator.
Determines if the parameter allows no value to be passed from it's
editor.
Only if this property is set to false null (
Nothing in VB) are considered as valid values of the
parameter.
Gets or sets a value that indicates whether an empty string is a valid value for the parameter.
Only for parameters of String.
Gets an object that defines a set of valid values the parameter can accept from.
The available values, or valid values, are a set of predefined values
which are acceptable as value of the parameter.
Each available value may have label that will be displayed if the parameter is visible.
Determines whether to trigger the report preview after changing the value for a parameter.
Applies only for visible parameters.
If this property is set to true, the report viewer will trigger
the report preview automatically when the parameter value is changed.
The parameter should be visible in order to auto preview the report.
Represents the available values for a
The available values, or valid values, are a set of predefined values
which are acceptable as value of the parameter.
Each available value may have label that will be displayed if the parameter is visible.
Gets or sets a string that specifies the property of the data source from which to draw the value labels.
Specifies a column name, expression, or
embedded expression
based on the
schema.
It is used as label in the value/label pair.
If omitted the ValueMember will be used as
as well.
Optional.
Gets or sets a string that specifies the field of the data source from which to draw the values.
Specifies a column name, expression, or
embedded expression
based on the
schema.
It is used as value in the value / label pair.
Gets or sets the data source used for retrieving the value / label pairs
of the available values.
For backwards compatibility reasons Telerik Reporting supports binding directly to
IEnumberable/IListSource objects (incl. arrays, collections, DataSet, DataTable,
DataView, and DbDataAdapter).
Instead consider using the
component that can handle these types of data sources.
Gets a FilterCollection that defines the filter expression(s).
Gets a SortingCollection that defines the sort column(s), and their type and order.
Represents a collection of objects.
Creates a with specific settings and
adds it to the
.
A value that will be used as
for the newly created
.
A value that will be used as
for the newly created
.
A value that will be used as
for the newly created
. May be expression.
The newly created and added
Inserts an item to the at
the specified index.
The zero-based index at which item should be
inserted.
The to insert into
the .
Values of type are accepted.
Values of type are accepted.
Values of type , ,
or are accepted. Internally the values are converted to .
Values of type or are accepted. Internally the values are converted to .
Values of type are accepted.
Gets or sets the text for the parameter to be displayed in the report viewer.
Determines whether the parameter user interface is visible.
Determines if the parameter can hold more then one value.
Determines if the parameter allows no value to be passed from it's editor.
Determines if the parameter allows an empty string to be passed. Only for parameters of type string.
Gets an object that defines a set of values the parameter can accept from.
Provides the base class for a report source. This is an abstract class
that contains only a collection of parameter values that are passed to the
object when its instance is initialized.
Determines the parameter values that are passed to the object when its instance is initialized.
The parameter name must match the name of the of the
in order the value to be passed correctly.
Represents a report source that loads a report document from a URI.
The following example demonstrates how to create a UriReportSource:
The storage may store single values - string or byte array, and a set of unordered string values.
Acquires a lock on a named resource.
Acquires a lock on a named resource and returns a disposable lock object.
When the lock object owner disposes it, the lock is released.
The name of the lock. When a lock with particular key is acquired,
a subsequent call on AcuireLock with the same key should wait until the original lock is
released (disposed).
A disposable lock object. When disposed from the lock object owner,
the lock of the used key is released.
Stores a string value under particular key.
The key that denotes the stored string value.
The value that is stored.
Stores a byte array value under particular key.
The key that denotes the stored byte array value.
The value that is stored.
Retrieves a string value stored under particular key.
The key that denotes the stored string value.
The string value stored under the given key. If no such key is found, null (Nothing).
Retrieves a byte array value stored under particular key.
The key that denotes the stored byte array value.
The byte array value stored under the given key. If no such key is found, null (Nothing).
Deletes a key with its value (string or byte array) from the storage.
The key that denotes the stored value that should be removed.
Retrieves a value indicating if a single value (string or byte array)
exists in the storage.
The key that denotes the stored value.
True if the key with its value exists in the storage,
otherwise false.
Retrieves a value indicating if a set of values
exists in the storage.
The key that denotes the stored set value.
True if the key with its value exists in the storage,
otherwise false.
Retrieves the count of the values in a set value stored in the storage.
The key that denotes the stored set value.
The count of the values in the set. If no such set exists, zero.
Retrieves all members in a set of string values.
The key that denotes the stored set value.
An enumerable retrieving each value of the set denoted from the given key.
Adds a single string value to a set of values denoted from the given key.
If a set with the given key does not exist in the storage, such set is created
and the value is added as its member.
The key that denotes the stored set value.
The value that is added to the set.
Deletes a single string value from a set of values denoted from the given key.
The key that denotes the stored set value.
The value that should be deleted from the given set.
True if set with the given key is found and it contained the given value before deleted.
Otherwise false.
Creates and initializes an instance of
MsSqlServerStorage.
The connection string to the backend storage.
Connection Strings in ADO.NET
Acquires a lock on a named resource.
Retrieves a value indicating if a single value (string or byte array)
exists in the storage.
Stores a string value under particular key.
Stores a byte array value under particular key.
Retrieves a string value stored under particular key.
Retrieves a byte array value stored under particular key.
Deletes a key with its value (string or byte array) from the storage.
Retrieves a value indicating if a set of values
exists in the storage.
Retrieves the count of the values in a set value stored in the storage.
Retrieves all members in a set of string values.
Adds a single string value to a set of values denoted from the given key.
Deletes a single string value from a set of values denoted from the given key.
Utility method. Creates the data schema (tables and stored procedures) needed from the storage.
Utility method. Clears all data from the storage data tables.
implementation utilizing the file system storage.
FileStorage is appropriate for
single instance deployment scenario only.
Creates an instance of the storage.
The target cache instance which will contain the stored values.
Acquires a lock on a named resource.
The name of the lock.
A disposable lock object.
Implements the interface member.
Retrieves a value indicating if a single value (string or byte array)
exists in the storage.
The key that denotes the stored value.
True if the key with its value exists in the storage,
otherwise false.
Implements the interface member.
Stores a string value under particular key.
The key that denotes the stored string value.
The value that is stored.
Implements the interface member.
Stores a byte array value under particular key.
The key that denotes the stored byte array value.
The value that is stored.
Implements the interface member.
Retrieves a string value stored under particular key.
The key that denotes the stored string value.
The string value stored under the given key. If no such key is found, null (Nothing).
Implements the interface member.
Retrieves a byte array value stored under particular key.
The key that denotes the stored byte array value.
The byte array value stored under the given key. If no such key is found, null (Nothing).
Implements the interface member.
Deletes a key with its value (string or byte array) from the storage.
The key that denotes the stored value that should be removed.
Implements the interface member.
Retrieves a value indicating if a set of values
exists in the storage.
The key that denotes the stored set value.
True if the key with its value exists in the storage,
otherwise false.
Implements the interface member.
Retrieves the count of the values in a set value stored in the storage.
The key that denotes the stored set value.
The count of the values in the set. If no such set exists, zero.
Implements the interface member.
Retrieves all members in a set of string values.
The key that denotes the stored set value.
An enumerable retrieving each value of the set denoted from the given key.
Implements the interface member.
Adds a single string value to a set of values denoted from the given key.
The key that denotes the stored set value.
The value that is added to the set.
Implements the interface member.
Deletes a single string value from a set of values denoted from the given key.
The key that denotes the stored set value.
The value that should be deleted from the given set.
True if set with the given key is found and it contained the given value before deleted.
Otherwise false.
Implements the interface member.
Creates an instance of the storage. The files representing the stored values
go under the current user's temporary folder.
Creates an instance of the storage.
The directory which will contain the files representing
the stored values.
Gets the root directory where data will be stored.
Represents an object which creates instances of particular storage implementation.
Creates an instance of storage.
The newly created storage instance.
Initializes the provider instance with parameters used
to configure each newly created storage instance
Dictionary of name-value pairs
representing storage configuration parameters.
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Returns all the extensions in the config file(Render, Delivery, ...)
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Use this property to access the parameters
Use this property to access the extensions
Internal use only
Internal use only
Use this property to access assembly references
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Internal use only
Gets or sets the name of the DataConnection component.
The name of the DataConnection component.
Gets or sets the connection string used to connect to data.
Gets or sets the name of the DataSource component.
The name of the DataSource component.
Gets the calculated fields collection.
Gets or sets an expression that defines the left side field used for binding.
Gets or sets an expression that defines the right side field used for binding.
Represents a data model, based on a textual Comma-Separated-Values data.
Initializes a new instance of the class.
Gets or sets the source of the CSV document.
The supported sources are:
1.
2.
3.
4.
Gets or sets the set of characters used as field separators (delimiters).
Gets or sets the character used as record separator.
Gets or sets the escape format of the CSV document.
Gets or sets the symbol used for escaping.
Gets or sets the symbol used for comments in the CSV document.
Gets or sets the setting that specifies if the CSV document has a header row.
Gets or sets the option for treating consecutive field separators as one in the CSV document.
Gets or sets the option for treating consecutive record separators as one in the CSV document.
Gets or sets the decimal separator used when parsing numbers.
Invariant culture's '.' separator is used by default.
Gets or sets the thousand separator used when parsing numbers.
Invariant culture's ',' separator is used by default.
Gets or sets the format used when parsing dates.
Gets a defining each column of the CSV data source.
When left empty, Columns are inferred from the data itself:
If header row is available, it is used to infer column names;
The type of each column is considered string.
Gets or sets the option for trimming the fields.
Represents the format that is used in a Csv file
in order to escape field values / special symbols.
No symbols are escaped.
Unix style programs use backslashes for escaping both (field and record) separators.
Backslash is escaped with a second backslash.
Some Unix style programs use backslashes for escaping field separators,
but for escaping record separators can use \r\n instead of backslash.
Backslash is escaped with a second backslash.
Excel uses single or double quotes to embed escaped text.
Single or double quotes are escaped with second single or double quotes.
Some files use a mixed escaping format -
fields are embedded in quotes (Excel like),
quotes (single or double) are escaped with backslash (Unix like).
Backslash is escaped with a second backslash.
Represents an OLAP cube to data items.
Initializes a new instance of the class.
Initializes a new instance of the class.
Specifies the connection string used to connect to the OLAP database.
Specifies the MDX select statement to execute against the OLAP cube.
Gets or sets the connection string used to connect to the OLAP database.
The ConnectionString property contains a valid connection string or a name of
a in the application's configuration file.
Gets or sets the MDX select statement to execute against the OLAP cube.
Gets a collection with objects.
The Parameters collection is used to pass named parameters when
executing a parameterized MDX select statement against the OLAP cube.
Gets a collection with objects.
The Mappings collection is used to map the names of the data source
fields to the actual fields returned when executing the MDX select statement.
Represents a parameter in a component.
Represents a parameter in a component.
Initializes a new instance of the class.
Initializes a new instance of the class.
Specifies the name of the parameter.
Initializes a new instance of the class.
Specifies the name of the parameter.
Specifies the value of the parameter.
Gets or sets the name of the parameter.
Gets or sets the value of the parameter.
Initializes a new instance of the class.
Initializes a new instance of the class.
Specifies the name of the parameter.
Initializes a new instance of the class.
Specifies the name of the parameter.
Specifies the value of the parameter.
Represents a collection of objects.
Initializes a new instance of the class.
Initializes a new instance of the class.
Specifies a range of parameters to add to the collection.
Initializes a new instance of the class.
Specifies a range of parameters to add to the collection.
Determines if the collection contains a parameter with the specified name.
Specifies the name of a parameter from the collection.
True if a parameter with the specified name exists, False otherwise.
Adds a new parameter with the specified name to the collection.
Specifies the name of the new parameter to add to the collection.
Adds a new parameter with the specified name and value to the collection.
Specifies the name of the new parameter to add to the collection.
Specifies the value of the new parameter to add to the collection.
Adds a range of parameters to the collection.
Specifies a range of parameters to add to the collection.
Adds a range of parameters to the collection.
Specifies a range of parameters to add to the collection.
Converts the collection to an array of parameters.
Array of parameters contained in the collection.
Clones the specified collection.
The source collection.
Gets the parameter with the specified name from the collection.
Specifies the name of a parameter from the collection.
The parameter with the specified name from the collection.
Represents an Entity data model to data items.
Gets a collection with s.
The Parameters property specifies a collection of parameters
to be passed to the constructor or the method of the business object
during data retrieval. If the DataSource property contains the
of a business object, and the DataMember
property is set to null (Nothing in Visual Basic) or an empty string,
the constructor with the specified parameters is invoked to create a
new instance of the business object. If the DataMember property
is set to a non-empty string that represents a valid method name, the
parameters are passed to the method with the matching signature.
Initializes a new instance of the class.
Initializes a new instance of the class.
Specifies the context used to connect to data.
Specifies the context member used to connect to data.
Initializes a new instance of the class.
Specifies the connection string used to connect to data.
Specifies the context used to connect to data.
Specifies the context member used to connect to data.
Gets or sets the connection string used to connect to data.
The ConnectionString property contains either a valid connection
string or the name of a in the
application configuration file.
Gets or sets the context used to connect to data.
The Context property can contain either an instance of
an context or the of such a context to be
created at run time.
Gets or sets the context member used to connect to data.
The ContextMember property contains the name of a property
or a method of the context to be invoked during data retrieval.
Gets or sets the context used to connect to data.
The Context property can contain either an instance of
an context or the of such a context to be
created at run time.
Gets or sets the context member used to connect to data.
The ContextMember property contains the name of a property
or a method of the context to be invoked during data retrieval.
Represents a business object to data items.
Creates a new instance of the class.
Creates a new instance of the class.
Specifies the data source object that is used to connect to data.
Specifies the data source member that is used to connect to data.
Gets or sets the data source object that is used to connect to data.
The DataSource property can contain either an instance of a
business object or the of such a business object
to be created at run time.
Gets or sets the data source member that is used to connect to data.
The DataMember property can contain the name of a property or
a method of the business object to be invoked during data retrieval.
If the DataSource property contains the of
a business object, and the DataMember property is set to null
(Nothing in Visual Basic) or an empty string, the constructor with
the specified parameters is invoked to create a new instance of the
business object.
Represents a parameter in an component.
Initializes a new instance of the class.
Initializes a new instance of the class.
Specifies the name of the parameter.
Initializes a new instance of the class.
Specifies the name of the parameter.
Specifies the data type of the parameter.
Initializes a new instance of the class.
Specifies the name of the parameter.
Specifies the data type of the parameter.
Specifies the value of the parameter.
Gets or sets the data type of the parameter.
Represents a collection of objects.
Initializes a new instance of the class.
Initializes a new instance of the class.
Specifies a range of parameters to add to the collection.
Initializes a new instance of the class.
Specifies a range of parameters to add to the collection.
Determines if the collection contains a parameter with the specified name.
Specifies the name of a parameter from the collection.
True if a parameter with the specified name exists, False otherwise.
Adds a new parameter with the specified name to the collection.
Specifies the name of the new parameter to add to the collection.
Adds a new parameter with the specified name and data type to the collection.
Specifies the name of the new parameter to add to the collection.
Specifies the data type of the new parameter to add to the collection.
Adds a new parameter with the specified name, data type and value to the collection.
Specifies the name of the new parameter to add to the collection.
Specifies the data type of the new parameter to add to the collection.
Specifies the value of the new parameter to add to the collection.
Adds a range of parameters to the collection.
Specifies a range of parameters to add to the collection.
Adds a range of parameters to the collection.
Specifies a range of parameters to add to the collection.
Converts the collection to an array of parameters.
Array of parameters contained in the collection.
Clones the specified collection.
The source collection.
Gets the parameter with the specified name from the collection.
Specifies the name of a parameter from the collection.
The parameter with the specified name from the collection.
Represents an Open Access data model to data items.
Initializes a new instance of the class.
Initializes a new instance of the class.
Specifies the connection string used to connect to data.
Specifies the object context used to connect to data.
Specifies the object context member used to connect to data.
Initializes a new instance of the class.
Specifies the connection string used to connect to data.
Specifies the object context used to connect to data.
Specifies the object context member used to connect to data.
Initializes a new instance of the class.
Specifies the managed provider name used to connect to data.
Specifies the connection string used to connect to data.
Specifies the object context used to connect to data.
Specifies the object context member used to connect to data.
Gets or sets the managed provider name used to connect to data.
If the ProviderName property is set to null (Nothing in Visual Basic)
or an empty string, the default provider is System.Data.SqlClient.
Gets or sets the connection string used to connect to data.
The ConnectionString property contains either a valid connection
string or the name of a in the
application configuration file.
Gets or sets the object context used to connect to data.
The ObjectContext property can contain either an instance of
an object context or the of such a context to be
created at run time.
Gets or sets the object context member used to connect to data.
The ObjectContextMember property contains the name of a property
or a method of the object context to be invoked during data retrieval.
Represents an assembly reference.
Generates an AssemblyRef from assembly .dll file location
Returns the resulting AssemblyRef
Returns a string that represents the current object.
Returns a string that represents the current object.
The name of the .dll file containing the .NET assembly
Assembly bytes in common object file format (COFF)-based image containing an emitted assembly
Represents a collection of Assembly References.
AssemblyRefCollection default constructor.
Creates an AssemblyRefCollection from AssemblyRef enumerable.
Assembly references enumerable from which to initialize the collection.
Adds the assembly pointed from the assemblyPath
along with the rest of the .dll files located in the same directory.
The path of the leading assembly
Clones the specified collection.
The source collection.
Adds a single assembly apointed from the assemblyPath parameter.
The path of the assembly to add a reference from
Allows a property of type Object to be edited like a string property in the Properties window
Represents the required information to connect to OpenEdge OpenClient
Gets or sets the URL of the AppServer endpoint
Absolute URL of the AppServer endpoint
Gets or sets the user name required to access the AppServer
The username required to access the AppServer
Gets or sets the password required to access the AppServer
The password required to access the AppServer
Gets or sets the additional settings information of the AppServer
The app server info.
Gets or sets the session model supported by the AppServer operating mode.
Represents the session model supported by the AppServer operating mode.
Managed session model
Session free model
Represents an dedicated component for retrieving data using OpenEdge OpenClient.NET proxy to ABL procedure.
Initializes a new instance of the class.
Gets or sets the data source object that is used to connect to data.
The DataSourceType property can contain name
that implements OpenEdge OpenClient AppObject
The assembly references collection containing the assembly
containing the type used in the property
along with all assembly dependencies.
The assembly containing the data retrieval type should be the
first one in the collection. Usually the other dependencies are
Progress.Messages.dll and Progress.o4glrt.dll
Gets or sets the name of the procedure that is used to retrieve the data.
The Procedure property contains the method name
of the AppObject to be invoked during data retrieval.
Gets or sets the name of the DataTable to be used from a the returned DataSet.
Applicable only if the procedure retrieves DataSet.
The DataTable property contains the name
of the DataTable to be used as data.
Gets the connection that is used to connect to OpendEdge OpenClient.
The Connection property contains all necessary options used to connect to OpenEdge AppServer.
Represents an SQL database to data items.
Initializes a new instance of the class.
Initializes a new instance of the class.
Specifies the connection string used to connect to data.
Specifies the SQL select statement or stored procedure to execute.
Initializes a new instance of the class.
Specifies the managed provider name used to connect to data.
Specifies the connection string used to connect to data.
Specifies the SQL select statement or stored procedure to execute.
Initializes a new instance of the class.
Specifies the managed provider name used to connect to data.
Specifies the connection string used to connect to data.
Specifies the SQL select statement or stored procedure to execute.
Specifies how the select command string to be interpreted.
Gets or sets the connection string used to connect to data.
The ConnectionString property contains either a valid connection
string or the name of a in the
application configuration file.
Gets or sets the managed provider name used to connect to data.
If the ProviderName property is set to null (Nothing in Visual Basic)
or an empty string, the default provider is System.Data.SqlClient.
Gets or sets the SQL select statement or stored procedure to execute.
Gets or sets a value indicating how the select command to be interpreted.
One of the enumeration values.
The default value of the SelectCommandType property is Text.
Gets a collection with data source parameters.
Gets or sets the wait time in seconds before terminating the attempt to retrieve data.
The provided value should be valid for the currently used data provider.
The time in seconds to wait before terminating the attempt to retrieve data.
The default value of the CommandTimeout property is 30 seconds.
Specifies how a command string is interpreted.
An SQL text command. (Default)
The name of a stored procedure.
Represents a parameter in a component.
Initializes a new instance of the class.
Initializes a new instance of the class.
Specifies the name of the parameter.
Initializes a new instance of the class.
Specifies the name of the parameter.
Specifies the data type of the parameter.
Initializes a new instance of the class.
Specifies the name of the parameter.
Specifies the data type of the parameter.
Specifies the value of the parameter.
Gets or sets the data type of the parameter.
Represents a collection of objects.
Initializes a new instance of the class.
Initializes a new instance of the class.
Specifies a range of parameters to add to the collection.
Initializes a new instance of the class.
Specifies a range of parameters to add to the collection.
Determines if the collection contains a parameter with the specified name.
Specifies the name of a parameter from the collection.
True if a parameter with the specified name exists, False otherwise.
Adds a new parameter with the specified name to the collection.
Specifies the name of the new parameter to add to the collection.
Adds a new parameter with the specified name and data type to the collection.
Specifies the name of the new parameter to add to the collection.
Specifies the data type of the new parameter to add to the collection.
Adds a new parameter with the specified name, data type and value to the collection.
Specifies the name of the new parameter to add to the collection.
Specifies the data type of the new parameter to add to the collection.
Specifies the value of the new parameter to add to the collection.
Adds a range of parameters to the collection.
Specifies a range of parameters to add to the collection.
Adds a range of parameters to the collection.
Specifies a range of parameters to add to the collection.
Converts the collection to an array of parameters.
Array of parameters contained in the collection.
Gets the parameter with the specified name from the collection.
Specifies the name of a parameter from the collection.
The parameter with the specified name from the collection.
Represents an user-defined field in a .
Gets or sets the name of the CalculatedField
Gets or sets the expression of the CalculatedField
Gets or sets the data type of the CalculatedField
Represents a collection of s.
Represents a mapping between a field from a data source and its
corresponding short alias used for data binding in expressions.
Initializes a new instance of the class.
Initializes a new instance of the class.
Specifies the name of the field for the mapping.
Specifies the alias of the field for the mapping.
Gets or sets the name of the field from the mapping.
Gets or sets the alias of the field from the mapping.
Represents a collection of objects.
Represents a collection of mappings for the fields of a data source and
their corresponding short aliases used for data binding in expressions.
Initializes a new instance of the class.
Initializes a new instance of the class.
Specifies a range of mappings to add to the collection.
Initializes a new instance of the class.
Specifies a range of mappings to add to the collection.
Determines if the collection contains a mapping for the specified field.
Specifies the name of a field from the collection.
True if a mapping for the specified field exists, False otherwise.
Adds a new mapping for the specified field to the collection.
Specifies the name of the field for the new mapping.
Specifies the alias of the field for the new mapping.
Adds a range of mappings to the collection.
Specifies a range of mappings to add to the collection.
Adds a range of mappings to the collection.
Specifies a range of mappings to add to the collection.
Converts the collection to an array of mappings.
Array of mappings contained in the collection.
Gets the mapping of the specified field from the collection.
Specifies the name of a field from the collection.
The mapping of the specified field from the collection.
Represents a collection of objects.
Initializes a new instance of the class.
Initializes a new instance of the class.
Specifies a range of parameters to add to the collection.
Initializes a new instance of the class.
Specifies a range of parameters to add to the collection.
Determines if the collection contains a parameter with the specified name.
Specifies the name of a parameter from the collection.
True if a parameter with the specified name exists, False otherwise.
Adds a new parameter with the specified name to the collection.
Specifies the name of the new parameter to add to the collection.
Adds a new parameter with the specified name and value to the collection.
Specifies the name of the new parameter to add to the collection.
Specifies the value of the new parameter to add to the collection.
Adds a range of parameters to the collection.
Specifies a range of parameters to add to the collection.
Adds a range of parameters to the collection.
Specifies a range of parameters to add to the collection.
Converts the collection to an array of parameters.
Array of parameters contained in the collection.
Gets the parameter with the specified name from the collection.
Specifies the name of a parameter from the collection.
The parameter with the specified name from the collection.
Represents a data column definition.
Creates a new instance of .
Creates a new instance of .
The name of the column.
This name should be used later when referring a field from this column in expressions.
The type of the column.
Gets or sets the name of the field definition. Used to access the field in expressions.
Field names must be unique in the context of a single report.
The name must be a valid identifier - may contain only digits (0-9), letters (a-z, A-Z),
and underscore sign (_). Must begin with a letter or underscore.
Gets or sets the type of the field.
Determines the type of the values. Acceptable values for each type are listed in .
The default parameter type is .
Represents a collection of objects.
Adds an enumerable of objects to the
.
An enumerable of objects to add to
the .
The objects returned from the
enumerable are appended to the end of the
.
Determines whether the
contains a column with a specific name.
A that specifies the parameter name for which
to search the elements of the
.
Returns a value indicating whether the
object contains a report
parameter with the specified name.
Determines the index of a specific column in the
.
The parameter name used to locate the report
parameter in the .
The index of column if found in the
; otherwise, -1.
Creates a with specific settings and
adds it to the
.
A value that will be used as
for the newly created
.
A constant will be used for the newly created
.
A value that will be used as
for the newly created
.
The newly created and added
Inserts an item to the at
the specified index.
The zero-based index at which item should be
inserted.
The to insert into
the .
Gets a column by name.
The name of the column.
A column if found; otherwise null (Nothing)
Allows a property of type Object to be edited like a string property in the Properties window
Converts the collection to string returning the count of items in it.
Parameter; Binding ...
Parameters; Bindings ...
Represents type options.
Values of type are accepted.
Values of type are accepted.
Values of type , ,
or are accepted. Internally the values are converted to .
Values of type or are accepted. Internally the values are converted to .
Values of type or are accepted. Internally the values are converted to .
Values of type are accepted.
The EncodingMode enumeration determines the type of the acceptable data.
Auto mode.
Accepts byte data.
Allows text data.
Allows numeric data.
Byte Mode.
Allows Text.
Allows numbers.
Not set currently.
Initializes a new instance of the class.
TODO: Update summary.
Initializes a new instance of the class.
This method encodes the data for the Kanji Mode.
Validates the data, to ensure no invalid characters are present.
Determines the type of code, such as Numeric, Alphanumeric, Byte or Kanji.
Byte Mode.
Allows Numbers [0-9].
Allows characters or numbers.
Kanji Mode.
Determines how much data is available for error correction.
Low.
Medium.
Quartile.
High.
Determines the Extended Channel Interpretation (ECI) mode, which allows for encoding of characters from other sets.
None.
ECI 9.
ECI 8.
ECI 7.
ECI 6.
ECI 5.
ECI 4.
ECI 3.
ECI 2.
ECI 1.
ECI 10.
ECI 11.
ECI 13.
ECI 15.
ECI 17.
ECI 21.
ECI 22.
ECI 23.
ECI 24.
ECI 27.
Signifies application of special formatting to the code data.
None.
FNC 1 in first position.
FNC 1 in second position.
Defines the PDF417 encoder class.
Defines the base class for all 2D barcode encoders.
Defines the base class for all barcode encoders.
Returns a string that represents the current object.
A string that represents the current object.
Creates an instance of the class.
Gets or sets the number of the columns.
This example illustrates how to set the Columns property.
// Create an instance of the report to print.
IReportDocument reportDocument = new MyReport();
// Obtain the settings of the default printer.
PrinterSettings printerSettings = new PrinterSettings();
// Adjust the printer settings if necessary...
// Print the report using the printer settings.
ReportProcessor.Print(reportDocument, printerSettings);
' Create an instance of the report to print.
Dim reportDocument As IReportDocument = New MyReport()
' Obtain the settings of the default printer.
Dim printerSettings As New PrinterSettings()
' Adjust the printer settings if necessary...
' Print the report using the printer settings.
ReportProcessor.Print(reportDocument, printerSettings)
Renders a report in the specified format
Export format
Report document to render.
Contains parameters to pass to the rendering extension.
The MIME type of the result buffer.
The file extension of the result buffer.
The character encoding of the result buffer.
Byte array that contains the rendered report.
Renders a report in the specified format
Export format
Report document to render.
Contains parameters to pass to the rendering extension.
The MIME type of the result buffer.
The name of the created document.
The file extension of the result buffer.
The character encoding of the result buffer.
Byte array that contains the rendered report.
Renders a report in the specified format
Export format
Report document to render
Contains parameters to pass to the rendering extension.
The delegate function to call to get a stream to render into.
True if the rendering succeeds.
Renders a report in the specified format
Export format
Report document to render
Contains parameters to pass to the rendering extension.
The delegate function to call to get a stream to render into.
The name of the created document.
True if the rendering succeeds.
Prints a report document using the specified printer settings.
Specifies the for the report document to print.
Specifies the printer settings to be used when printing the document.
If null or invalid settings are specified, the Print Dialog appears.
To prevent the Print Dialog from appearing, you should specify valid
printer settings to this method.
This example illustrates how to prevent the standard Print Dialog from
appearing in a batch print operation or when printing from a service.
Note that the database cache implementation relies on the Telerik OpenAccess
so the following OpenAccess core libraries should be referenced: Telerik.OpenAccess.dll, Telerik.OpenAccess.35.Extensions.dll .
Proper assembly binding redirects might apply.
See also: Configuring the Database Cache Provider
Report service configuration that upon creation reads the restReportService
configuration element from the application configuration file.
Default implementation of the interface.
Represents an object containing all dependencies and setting
which the REST report service needs to operate.
Gets or sets the unique constant name of the application hosting the reports service.
When not set the report service utilizes
the
AppDomainSetup.ApplicationName Property
for the current application domain.
This however is not sufficient for each application setup.
Set a value for this property in order to provide an unique name among all apps
implementing the report service that will be deployed in the same environment.
Gets or sets a value in minutes indicating how long a client session
will be preserved in the service storage after the last interaction
from this client.
The value must be greater than zero.
Gets or sets a value in minutes indicating how long a rendered
report document from a client will be viable for reuse for another
clients' request.
The value must be greater or equal to zero. A zero value will
prevent rendered report document reuse.
Gets or sets an
implementation instance that will be used for internal storage from the report service.
Use this property setter in order to provide a storage instance.
May be one of the built-in storage implementations or a custom implementation.
This is mandatory setting without defaults.
Gets or sets an
implementation instance that will be used for report resolving from the service.
Use this property setter in order to provide a report resolver instance.
May be one of the built-in report resolvers or a custom implementation resolver.
Built-in resolvers may be chained.
This is mandatory setting without defaults.
Creates an instance of the ReportServiceConfiguration class.
Gets or sets the unique constant name of the application hosting the reports service.
When not set the report service utilizes
the
AppDomainSetup.ApplicationName Property
for the current application domain.
This however is not sufficient for each application setup.
Set a value for this property in order to provide an unique name among all apps
implementing the report service that will be deployed in the same environment.
Gets or sets a value in minutes indicating how long a client session
will be preserved in the service storage after the last interaction
from this client.
The value must be greater than zero. The default value is 15 minutes
Gets or sets a value in minutes indicating how long a rendered
report document from a client will be viable for reuse for another
clients' request.
The value must be greater or equal to zero. A zero value will
prevent rendered report document reuse. The default value is zero.
Gets or sets an
implementation instance that will be used for internal storage from the report service.
Use this property setter in order to provide a storage instance.
May be one of the built-in storage implementations or a custom implementation.
This is mandatory setting without defaults.
Gets or sets an
implementation instance that will be used for report resolving from the service.
Use this property setter in order to provide a report resolver instance.
May be one of the built-in report resolvers or a custom implementation resolver.
Built-in resolvers may be chained.
This is mandatory setting without defaults.
Creates an instance of the ConfigSectionReportServiceConfiguration type
and populates any configuration properties that are setup in the config file.
Persistable object identified by Key object (K)
Key object type
Defines a class for storing error information.
Gets or sets the high-level, user-visible message explaining the cause of the error.
Gets or sets the message of the if available.
Gets or sets the type of the if available.
Gets or sets the stack trace information associated with this instance if available.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Represents a resolver that creates from a string representation of a report document reference
Creates a based on its string representation.
The string representation of a report document reference
Supported from the engine are and
Represents an object which creates instances of particular report resolver implementation.
Creates an instance of report resolver.
The newly created report resolver instance.
Initializes the provider instance with parameters used
to configure each newly created report resolver instance
Dictionary of name-value pairs
representing report resolver configuration parameters.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Telerik internal use only.
Provides static (Shared in Visual Basic) extension methods for objects that implement the interface.
Validates an object representing a report service configuration.
The object that should be validated.
This method is used internally from the report service.
If specified will be used to parse each parameter value before using.
Telerik internal use only.
Telerik internal use only.
Internal use only.
Telerik internal use only.
Telerik internal use only.
Internal use only
Internal use only
Graphics for the string measurements
Used by the group footers with print on every page;
!!! Relative to the current top !!!
Called when the paging of the current page is completed and is ready
for sending to the client.
If true send the page anyway;
otherwise only when there is no more free space left on the page
For the string measurements
Used by the group footers with print on every page;
!!! Relative to the current top !!!
Adjust the item's top position.
If any of the dependent items are grown and overlaps the current item,
move it down preserving the smallest vertical distance
between this item and the dependent items.
Move the item down and right with the given offsets
in absolute coordinates
The intersection between the rect and the page's rect;
If rect is empty, returns the page rect.
Current page Top + reserved top space for this item
Current page Bottom - reserved bottom space for this item
Min distance that the container should preserve
Determines whether the item starts from current page
and continue on the next
Defines whether to calculate the child items.
Returns the text rotation angle in degrees.
Report Header/Footer sections
Detail section
Group Header/Footer sections
Keeps the offsetY for the position of the fixed header on the current page
Keeps the offsetY for the position of the fixed footer on the current page
Implements KeepTogether = true
A line always must stay together.
Number of the page in the output document (including pages from previous reports if ReportBook).
In page coordinates.
In page coordinates.
In page coordinates.
In page coordinates.
In page coordinates.
Borders to render on the current page
Gets a value indicating if the element is actually clipped.
Gets a value indicating if the client area is actually clipped.
The index of the first row not part of the region
The index of the first column not part of the region
The count of lines this cell spans on
The count of cells on each occupied line this cell spans on
Used instead of RectangleRF when reference type needed.
Indicates that the item should be position on the top
of the next page (PagingElementBase.VerticalStateOffset - to offset
from the top)
Try keeping together the header lines + the 1st body line
Calculates the minimum reserved end space
to ensure correct calculates of cell items (KeepTogether/CalculatePage)
The number of the entire lines
(including lines bigger than 1 page) that fit on current page
Just aligns the text inside the client rectangle without
any measurements
Measures the text bounds inside the ITextContainer.ClientRectangle
so that further paging / rendering can be applied on the returned bounds.
Returns the text rotation angle in degrees.
For dashed and dotted borders
Outer stripe
Called when the rendering of the entire report document is completed.
Ends the composition and disposes all composition-wide resources
Called when the rendering of the current page is completed and is ready
for sending to the client.
Graphics for the string measurements
Called when new page should be prepared for rendering.
Called when the rendering of the current page is completed and is ready
for sending to the client.
Creates 1bpp bitmap from a given bitmap.
bitmap to conver to bitonal
1bpp bitmap
DrawImage
Image to draw
in Millimeters
in Pixels
Helper class.
Saves current canvas state and restores in on disposal
DrawImage
Image to draw
in Millimeters
in Pixels
Converts a rectangle in mm to points.
Called when new page should be prepared for rendering.
Called when the rendering of the entire report document is completed.
Ends the composition and disposes all document-wide resources.
Called when the rendering of the entire report document is completed.
Ends the composition and disposes all composition-wide resources
Represents the internal state of an PdfGraphics object.
Gets or sets the current transformation matrix.
Represents a stack of PdfGraphicsState and XGraphicsContainer objects.
Defines an object used to draw glyphs.
Cache PdfFontInfo to speed up finding the right PdfFontDictionary
if this font is used more than once.
Returns the line spacing, in pixels, of this font. The line spacing is the vertical distance
between the base lines of two consecutive lines of text. Thus, the line spacing includes the
blank space between lines along with the height of the character itself.
Gets the face name of this Font object.
Gets the em-size of this Font object measured in the unit of this
Font object.
Indicates whether this PdfFontDictionary object is bold.
Indicates whether this PdfFontDictionary object is italic.
Indicates whether this PdfFontDictionary object is underline.
Indicates whether this PdfFontDictionary object is strikeout.
Summary description for PdfFontMetrics.
The transformation matrix from the XGraphics page space to the Graphics world space.
(The name 'default view matrix' comes from Microsoft OS/2 Presentation Manager. I choose
this name because I have no better one.)
The graphics state stack.
The transformation matrix from XGraphics world space to page unit space.
Initializes a new instance of the PdfGraphics class for drawing on
a PDF page and provides a GDI+ Graphics object for measurements.
Applies the specified translation operation to the transformation matrix of this object by
prepending it to the object's transformation matrix.
Applies the specified translation operation to the transformation matrix of this object
in the specified order.
Resets the transformation matrix of this object to the identity matrix.
Saves the current state of this XGraphics object and identifies the saved state with the
returned PdfGraphicsState object.
Restores the state of this XGraphics object to the state represented by the specified
PdfGraphicsState object.
Empties the clip region, i.e. no clipping takes place.
Draws an image.
The image to draw.
The destination rectangle in POINTS.
The source rectangle in PIXELS.
Draws a line connecting the two points specified by coordinate pairs.
Gets or sets the transformation matrix.
Represents the internal state of an XGraphics object.
Defines an object used to draw GDI Images.
Represents a 3-by-3 matrix that represents an affine 2D transformation.
Degree to radiant factor.
Half of pi.
Initializes a new instance of the Matrix class with the specified points.
Inverts this PdfMatrix object. Throws an exception if the matrix is not invertible.
Multiplies this matrix with the specified matrix.
Multiplies this matrix with the specified matrix.
Translates the matrix with the specified offsets.
Translates the matrix with the specified offsets.
Scales the matrix with the specified scalars.
Scales the matrix with the specified scalars.
Scales the matrix with the specified scalar.
Scales the matrix with the specified scalar.
Rotates the matrix with the specified angle.
Rotates the matrix with the specified angle.
Shears the matrix with the specified scalars.
Shears the matrix with the specified scalars.
Converts this matrix to a System.Drawing.Drawing2D.Matrix object.
Indicates whether this instance and a specified object are equal.
Explicitly converts a PdfMatrix to an Matrix.
Explicitly converts a Matrix to an PdfMatrix.
Determines whether to matrices are equal.
Determines whether to matrices are not equal.
Gets an array of double values that represents the elements of this matrix.
Gets a value from the matrix.
Gets a value from the matrix.
Gets a value from the matrix.
Gets a value from the matrix.
Gets the x translation value.
Gets the y translation value.
Indicates whether this matrix is the identity matrix.
Indicates whether this matrix is invertible, i. e. its determinant is not zero.
PdfMatrixOrder
The new operation is applied before the old operation.
The new operation is applied after the old operation.
Implements the ASCII85Decode filter.
Base class for all stream filters
When implemented in a derived class encodes the specified data.
Encodes a raw string.
When implemented in a derived class decodes the specified data.
Decodes to a raw string.
Removes all white spaces from the data. The function assumes that the bytes are characters.
Implements the ASCIIHexDecode filter.
Summary description for Filtering.
Gets the filter specified by the case sensitive name.
Gets the filter singleton.
Gets the filter singleton.
Gets the filter singleton.
Implements the FlateDecode filter by wrapping SharpZipLib.
CMap format 4: Segment mapping to delta values.
The Windows standard format.
Converts the width of a glyph identified by its index to PDF design units.
Character To Glyph Index Mapping Table
This table defines the mapping of character codes to the glyph index
values used in the font. It may contain more than one subtable, in
order to support more than one character encoding scheme. Character
codes that do not correspond to any glyph in the font should be mapped
to glyph index 0. The glyph at this location must be a special glyph
representing a missing character, commonly known as .notdef.
When overridden in a derived class, prepares the font table to be
compiled into its binary representation.
Calculates the checksum of a table represented by its bytes.
Is true for symbol font encoding.
This table contains a list of values that can be referenced by
instructions. They can be used, among other things, to control
characteristics for different glyphs. The length of the table must be
an integral number of FWORD units.
Represents an entry in the TableDirectory of a TrueType font program.
4 -byte tag.
CheckSum for this table.
Offset from beginning of TrueType font file.
Actual table length of this table in bytes.
Gets the table length rounded up to a multiple of 4 bytes.
Represents a TrueType Collection (.ttc).
Reads a System.Byte.
Reads a System.Int16.
Reads a System.UInt16.
Reads a System.Int32.
Reads a System.UInt32.
Reads a System.Int32.
Reads a System.Int16.
Reads a System.UInt16.
Reads a System.Int64.
Reads a System.String with the specified size.
Reads a System.Byte[] with the specified size.
Reads a System.Byte[] with the specified size.
Reads a System.Char[4] as System.String.
A collection of information that uniquely idendifies a particular font.
Used to map PdfFontDictionary to Drawing.PdfFontDictionary.
There is a one to one relationship between a FontDescriptorInfo and a
TrueType/OpenType file.
Returns a string for diagnostic purposes only.
Font Header
This table gives global information about the font. The bounding box
values should be computed using only glyphs that have contours. Glyphs
with no contours should be ignored for the purposes of these
calculations.
Reads all required tables from the font program starting at the
specified offset.
Compiles the font to its binary representation.
Creates a new font image that is a subset of this font image
containing only the specified glyphs.
Adds the specified table to this font image.
Font Program Table
This table is similar to the CVT Program, except that it is only run
once, when the font is first used. It is used only for FDEFs and IDEFs.
Thus the CVT Program need not contain function definitions. However,
the CVT Program may redefine existing FDEFs or IDEFs.
This table is optional.
Represents a writer for generation of font file streams.
Closes the writer and, if specified, the underlying stream.
Closes the writer and the underlying stream.
Writes the specified value to the font stream.
Writes the specified value to the font stream.
Writes the specified value to the font stream using big-endian.
Writes the specified value to the font stream using big-endian.
Writes the specified value to the font stream using big-endian.
Writes the specified value to the font stream using big-endian.
Writes the specified value to the font stream using big-endian.
Writes the specified value to the font stream using big-endian.
Gets the underlying stream.
Gets or sets the position within the stream.
This table contains information that describes the glyphs in the font in the TrueType outline format.
Information regarding the rasterizer (scaler) refers to the TrueType rasterizer.
Prepares the font table to be compiled into its binary representation.
Gets the data of the specified glyph.
Gets the size of the byte array that defines the glyph.
Gets the offset of the specified glyph relative to the first byte of the font image.
Adds for all composite glyphs the glyphs the composite one is made of.
If the specifed glyph is a composite glyph add the glyphs it is made of the the glyph table.
The Glyph Substitution table (GSUB) contains information for
substituting glyphs to render the scripts and language systems
supported in a font. Many language systems require glyph substitutes.
For example, in the Arabic script, the glyph shape that depicts a
particular character varies according to its position in a word or text
string (see figure 1). In other language systems, glyph substitutes are
aesthetic options for the user, such as the use of ligature glyphs in
the English language (see Figure 2).
Horizontal Header Table
This table contains information for horizontal layout. The values in
the minRightSidebearing, minLeftSideBearing and xMaxExtent should be
computed using only glyphs that have contours. Glyphs with no contours
should be ignored for the purposes of these calculations. All reserved
areas must be set to 0.
Horizontal Metrics Table
Index to Location Table
The indexToLoc table stores the offsets to the locations of the glyphs
in the font, relative to the beginning of the glyphData table. In order
to compute the length of the last glyph element, there is an extra
entry after the last valid index.
Prepares the font table to be compiled into its binary representation.
This table establishes the memory requirements for this font.
Fonts with CFF data must use Version 0.5 of this table, specifying only the numGlyphs field.
Fonts with TrueType outlines must use Version 1.0 of this table, where all data is required.
Both formats of OpenType require a 'maxp' table because a number of applications call the
Windows GetFontData() API on the 'maxp' table to determine the number of glyphs in the font.
The naming table allows multilingual strings to be associated with the
OpenTypeTM font file. These strings can represent copyright notices,
font names, family names, style names, and so on. To keep this table
short, the font manufacturer may wish to make a limited set of entries
in some small set of languages; later, the font can be "localized" and
the strings translated or added. Other parts of the OpenType font file
that require these strings can then refer to them simply by their index
number. Clients that need a particular string can look it up by its
platform ID, character encoding ID, language ID and name ID. Note that
some platforms may require single byte character strings, while others
may require double byte strings.
For historical reasons, some applications which install fonts perform
version control using Macintosh platform (platform ID 1) strings from
the 'name' table. Because of this, we strongly recommend that the
'name' table of all fonts include Macintosh platform strings and that
the syntax of the version number (name id 5) follows the guidelines
given in this document.
The OS/2 table consists of a set of metrics that are required in
OpenType fonts.
Post Script Table
This table contains additional information needed to use TrueType or
OpenTypeTM fonts on PostScript printers.
The TrueType font descriptor.
Base class for all font descriptors.
Under Construction
Maps a unicode to the index of the corresponding glyph.
See OpenType spec "cmap - Character To Glyph Index Mapping Table / Format 4: Segment mapping to delta values"
for details about this a little bit strange looking algorhitm.
Converts the width of a glyph identified by its index to PDF design units.
Initializes a new instance of the class.
Writes a table name.
Character table by name.
An encoder for PDF DocEncoding.
Converts WinAnsi to DocEncode characters. Incomplete, just maps € and some other characters.
Summary description for PdfEncoding.
Converts a float into a string with up to 3 decimal digits and a decimal point.
Converts an Matrix into a string with up to 3 decimal digits and a decimal point.
Converts an Color into a string with up to 3 decimal digits and a decimal point.
Converts a raw string into a raw string literal, possibly encrypted.
Converts a raw string into a raw string literal, possibly encrypted.
Converts the specified byte array into a byte array representing a
string literal.
The bytes of the string.
Indicates whether one or two bytes are one
character.
Indicates whether to use Unicode prefix FEFF.
Indicates whether to create a hexadecimal string
literal.
The PDF bytes.
Gets the ASCII encoding.
Gets the Windows 1252 (ANSI) encoding.
Gets the PDF DocEncoding encoding.
Gets the UNICODE little-endian encoding.
Gets the raw Unicode encoding.
Summary description for PdfWriter.
Indicates whether the specified character is a PDF delimiter
character.
Increases indent level.
Decreases indent level.
Begins a direct or indirect dictionary or array.
Ends a direct or indirect dictionary or array.
Writes the stream of the specified dictionary.
Writes the specified value to the PDF stream.
Writes the specified value to the PDF stream.
Writes the specified value to the PDF stream.
Writes the specified value to the PDF stream.
Writes the specified value to the PDF stream.
Gets an indent string of current indent.
Determines how the PDF output stream is formatted. Even all formats create valid PDF files,
only Compact or Standard should be used for production purposes.
The PDF stream contains no unnecessary characters. This is default in release build.
The PDF stream contains some superfluous line feeds, but is more readable.
The PDF stream is indented to reflect the nesting levels of the objects. This is usedful
for analysing PDF files, but increases the size of the file significantly.
The PDF stream is indented to reflect the nesting levels of the objects and contains additional
information about the PDFsharp objects. Furthermore content streams are not deflated. This
is usedful for debugging purposes only and increases the size of the file significantly.
An encoder for raw strings. The raw encoding is simply the identity relation between
charachters and bytes. Telerik PDF internally works with raw encoded strings instead of
byte arrays because strings are much more handy than byte arrays.
An encoder for Unicode strings.
Required native Win32 calls. Don't know what to do under Mono.
Reflected from System.Drawing.SafeNativeMethods+LOGFONT
The q/Q nesting level is 0.
The q/Q nesting level is 1.
The q/Q nesting level is 2.
The nesting level of the PDF graphics state stack when the clip
region was set to non empty. Because of the way PDF is made the
clip region can only be reset at this level.
The graphical state stack.
The current graphical state.
The final transformation from the world space to the default page
space.
Appends the content of a GraphicsPath object.
Begins the graphic mode (i.e. ends the text mode).
Gets the content created by this renderer.
Gets the resource name of the specified font within this page or form.
Saves the current graphical state.
Restores the previous graphical state.
Initializes the default view transformation, i.e. the
transformation from the user page space to the PDF page space.
Ends the content stream, i.e. ends the text mode and balances the
graphic state stack.
Realizes the current transformation matrix, if necessary.
Makes the specified pdfFont and brush to the current graphics objects.
Makes the specified gdiImage to the current graphics object.
Gets the resource name of the specified gdiImage within this page or form.
Clones the current graphics state and push it on a stack.
Sets the clip path empty. Only possible if graphic state level has
the same value as it has when the first time SetClip was invoked.
Appends one or up to five Bézier curves that interpolate the arc.
Gets the quadrant (0 through 3) of the specified angle. If the angle lies on an edge
(0, 90, 180, etc.) the result depends on the details how the angle is used.
Appends a Bézier curve for an arc within a quadrant.
Strokes a single connection of two points.
Strokes a series of connected points.
Gets the owning PdfDocument of this page or form.
Gets the PdfResourcesDictionary of this page or form.
Gets the size of this page or form.
Indicates how to handle the first point of a path.
Set the current position to the first point.
Draws a line to the first point.
Ignores the first point.
Degree to radiant factor.
Half of pi.
Represents the current PDF graphics state.
The current transformation matrix.
The unupdated current transformation matrix.
A flag indicating whether the CTM must be realized.
Modifies the current transformation matrix.
Realizes the Current Transformation Matrix.
Converts an array of run embedding levels to a map of
visual-to-logical position and/or logical-to-visual position.
[in] Number of runs to process.
[in] Pointer to an array, of length cRuns,
containing run embedding levels. Embedding levels for all runs on
the line must be included, ordered logically. For more information,
see the Remarks section.
[out] Pointer to an array, of
length cRuns, in which this function retrieves the run embedding
levels reordered to visual order. The first array element
represents the run to display at the far left, and subsequent
entries should be displayed progressing from left to right. The
function sets this parameter to a null pointer if there is no output.
[out] Pointer to an array, of
length cRuns, in which this function retrieves the visual run
positions. The first array element is the relative visual position
where the first logical run should be displayed, the leftmost
display position being 0. The function sets this parameter to a
null pointer if there is no output.
Returns 0 if successful. The function returns a nonzero
HRESULT value if it does not succeed. The application can test the
return value with the SUCCEEDED and FAILED macros.
The crc data checksum so far.
Resets the CRC32 data checksum as if no update was ever called.
Updates the checksum with the int value.
the byte is taken as the lower 8 bits of value
Updates the checksum with the bytes taken from the array.
buffer an array of bytes
Adds the byte array to the data checksum.
the buffer which contains the data
the offset in the buffer where the data starts
the length of the data
Returns the CRC32 data checksum computed so far.
Returns the CRC32 data checksum computed so far.
Hold information about the value of a key in a dictionary.
Initializes a new instance of KeyDescriptor from the specified
attribute during a KeysMeta. Initializes itself using reflection.
Returns the type of the object to be created as value for the described key.
Gets or sets the PDF version starting with the availability of the
described key.
A JavaScript action (PDF 1.3) causes a script to be compiled and
executed by the JavaScript interpreter. Depending on the nature of the
script, various interactive form fields in the document may update their
values or change their visual appearances. Netscape Communications
Corporation’s Client-Side JavaScript Reference and the Adobe JavaScript
for Acrobat API Reference (see the Bibliography) give details on the
contents and effects of JavaScript scripts. Table 8.90 shows the action
dictionary entries specific to this type of action.
3.2.6
A dictionary object is an associative table containing pairs of objects,
known as the dictionary’s entries. The first element of each entry is
the key and the second element is the value. The key must be a name
(unlike dictionary keys in Post-Script, which may be objects of any
type). The value can be any kind of object, including another
dictionary. A dictionary entry whose value is null (see Section 3.2.8,
“Null Object”) is equivalent to an absent entry. (This differs from
Post-Script, where null behaves like any other object as the value of a
dictionary entry.) The number of entries in a dictionary is subject to
an implementation limit; see Appendix C.
Summary description for PdfObject.
The base class of all PDF objects and simple types.
All simple types (i.e. derived from PdfItem but not from PdfObject)
must be immutable.
Creates a copy of this object.
Implements the copy mechanism. Must be overridden in derived classes.
When overridden in a derived class, appends a raw string representation of this object
to the specified PdfWriter.
When overridden in a derived class, prepares the object to get saved.
Saves the stream position. 2nd Edition.
...
Setting the object identifier makes this object an indirect object,
i.e. the object gets a PdfReference entry in the PdfReferenceTable.
Gets the PdfDocument this object belongs to.
Gets the indirect reference of this object. If the value is null,
this object is a direct object.
Gets the object identifier. Returns PdfObjectID.Empty for direct
objects.
Ssets the PdfDocument this object belongs to.
Indicates whether the object is an indirect object.
Creates the stream of this dictionary and initializes it with the specified byte array.
The function must not be called if the dictionary already has a strem.
Writes a key/value pair of this dictionary. This function is
intended to be overridden in derived classes.
Writes the stream of this dictionary. This function is intended to be overridden
in a derived class.
When overridden in a derived class, gets the KeysMeta of this
dictionary type.
Gets the hashtable containing the elements of this dictionary.
Gets or sets the PDF stream belonging to this dictionary. Returns null if the dictionary has
no stream. To create the stream, call the CreateStream function.
The actual javascript source code.
Gets the KeysMeta of this dictionary type.
Base class for all dictionary Keys classes.
(Required) The type of action that this dictionary describes;
must be JavaScriptNameTree for a JavaScriptNameTree action.
(Required) A text string or text stream containing the
JavaScriptNameTree script to be executed.
_Note: PDFDocEncoding or Unicode encoding (the latter identified
by the Unicode prefix U+ FEFF) is used to encode the contents
of the string or stream. (See implementation _note 126 in
Appendix H.)
Gets the KeysMeta for these keys.
Specifes the type of a key's value in a dictionary.
Summary description for KeyInfo.
The width or height of the page are set manually and override the PageSize property.
Identifies a pager sheet size of 841 mm times 1189 mm or 33.11 inch times 46.81 inch.
Identifies a pager sheet size of 594 mm times 841 mm or 23.39 inch times 33.1 inch.
Identifies a pager sheet size of 420 mm times 594 mm or 16.54 inch times 23.29 inch.
Identifies a pager sheet size of 297 mm times 420 mm or 11.69 inch times 16.54 inch.
Identifies a pager sheet size of 210 mm times 297 mm or 8.27 inch times 11.69 inch.
Identifies a pager sheet size of 148 mm times 210 mm or 5.83 inch times 8.27 inch.
Identifies a pager sheet size of 860 mm times 1220 mm.
Identifies a pager sheet size of 610 mm times 860 mm.
Identifies a pager sheet size of 430 mm times 610 mm.
Identifies a pager sheet size of 305 mm times 430 mm.
Identifies a pager sheet size of 215 mm times 305 mm.
Identifies a pager sheet size of 153 mm times 215 mm.
Identifies a pager sheet size of 1000 mm times 1414 mm or 39.37 inch times 55.67 inch.
Identifies a pager sheet size of 707 mm times 1000 mm or 27.83 inch times 39.37 inch.
Identifies a pager sheet size of 500 mm times 707 mm or 19.68 inch times 27.83 inch.
Identifies a pager sheet size of 353 mm times 500 mm or 13.90 inch times 19.68 inch.
Identifies a pager sheet size of 250 mm times 353 mm or 9.84 inch times 13.90 inch.
Identifies a pager sheet size of 176 mm times 250 mm or 6.93 inch times 9.84 inch.
Identifies a pager sheet size of 10 inch times 8 inch or 254 mm times 203 mm.
Identifies a pager sheet size of 13 inch times 8 inch or 330 mm times 203 mm.
Identifies a pager sheet size of 10.5 inch times 7.25 inch or 267 mm times 184 mm.
Identifies a pager sheet size of 10.5 inch times 8 inch 267 mm times 203 mm.
Identifies a pager sheet size of 11 inch times 8.5 inch 279 mm times 216 mm.
Identifies a pager sheet size of 14 inch times 8.5 inch 356 mm times 216 mm.
Identifies a pager sheet size of 17 inch times 11 inch or 432 mm times 279 mm.
Identifies a pager sheet size of 17 inch times 11 inch or 432 mm times 279 mm.
Identifies a pager sheet size of 19.25 inch times 15.5 inch 489 mm times 394 mm.
20 ×Identifies a pager sheet size of 20 inch times 15 inch or 508 mm times 381 mm.
Identifies a pager sheet size of 21 inch times 16.5 inch 533 mm times 419 mm.
Identifies a pager sheet size of 22.5 inch times 17.5 inch 572 mm times 445 mm.
Identifies a pager sheet size of 23 inch times 18 inch or 584 mm times 457 mm.
Identifies a pager sheet size of 25 inch times 20 inch or 635 mm times 508 mm.
Identifies a pager sheet size of 28 inch times 23 inch or 711 mm times 584 mm.
Identifies a pager sheet size of 35 inch times 23.5 inch 889 mm times 597 mm.
Identifies a pager sheet size of 45 inch times 35 inch or × mm times 1143 × 889 mm.
Identifies a pager sheet size of 8.5 inch times 5.5 inch 216 mm times 140 mm.
Converts the specified page size enumeration to a pair of values in point.
Represents the base class of all annotations.
Initializes a new instance of the class.
Initializes a new instance of the class.
Gets or sets the annotation flags of this instance.
Gets or sets the PdfAnnotations object that this annotation belongs to.
Gets or sets the annotation rectangle, defining the location of the annotation
on the page in default user space units.
Gets or sets the text label to be displayed in the title bar of the annotation’s
pop-up window when open and active. By convention, this entry identifies
the user who added the annotation.
Gets or sets text representing a short description of the subject being
addressed by the annotation.
Gets or sets the text to be displayed for the annotation or, if this type of
annotation does not display text, an alternate description of the annotation’s
contents in human-readable form.
Predefined keys of this dictionary.
(Optional) The type of PDF object that this dictionary describes; if present,
must be Annot for an annotation dictionary.
(Required) The type of annotation that this dictionary describes.
(Required) The annotation rectangle, defining the location of the annotation
on the page in default user space units.
(Optional) Text to be displayed for the annotation or, if this type of annotation
does not display text, an alternate description of the annotation’s contents
in human-readable form. In either case, this text is useful when
extracting the document’s contents in support of accessibility to users with
disabilities or for other purposes.
(Optional; PDF 1.4) The annotation name, a text string uniquely identifying it
among all the annotations on its page.
(Optional; PDF 1.1) The date and time when the annotation was most recently
modified. The preferred format is a date string, but viewer applications should be
prepared to accept and display a string in any format.
(Optional; PDF 1.1) A set of flags specifying various characteristics of the annotation.
Default value: 0.
(Optional; PDF 1.2) A border style dictionary specifying the characteristics of
the annotation’s border.
(Optional; PDF 1.2) An appearance dictionary specifying how the annotation
is presented visually on the page. Individual annotation handlers may ignore
this entry and provide their own appearances.
(Required if the appearance dictionary AP contains one or more subdictionaries; PDF 1.2)
The annotation’s appearance state, which selects the applicable appearance stream from
an appearance subdictionary.
(Optional) An array specifying the characteristics of the annotation’s border.
The border is specified as a rounded rectangle.
In PDF 1.0, the array consists of three numbers defining the horizontal corner
radius, vertical corner radius, and border width, all in default user space units.
If the corner radii are 0, the border has square (not rounded) corners; if the border
width is 0, no border is drawn.
In PDF 1.1, the array may have a fourth element, an optional dash array defining a
pattern of dashes and gaps to be used in drawing the border. The dash array is
specified in the same format as in the line dash pattern parameter of the graphics state.
For example, a Border value of [0 0 1 [3 2]] specifies a border 1 unit wide, with
square corners, drawn with 3-unit dashes alternating with 2-unit gaps. Note that no
dash phase is specified; the phase is assumed to be 0.
Note: In PDF 1.2 or later, this entry may be ignored in favor of the BS entry.
(Optional; PDF 1.1) An array of three numbers in the range 0.0 to 1.0, representing
the components of a color in the DeviceRGB color space. This color is used for the
following purposes:
• The background of the annotation’s icon when closed
• The title bar of the annotation’s pop-up window
• The border of a link annotation
(Optional; PDF 1.1) An action to be performed when the annotation is activated.
Note: This entry is not permitted in link annotations if a Dest entry is present.
Also note that the A entry in movie annotations has a different meaning.
(Optional; PDF 1.1) The text label to be displayed in the title bar of the annotation’s
pop-up window when open and active. By convention, this entry identifies
the user who added the annotation.
(Optional; PDF 1.3) An indirect reference to a pop-up annotation for entering or
editing the text associated with this annotation.
(Optional; PDF 1.4) The constant opacity value to be used in painting the annotation.
This value applies to all visible elements of the annotation in its closed state
(including its background and border) but not to the popup window that appears when
the annotation is opened.
The specified value is not used if the annotation has an appearance stream; in that
case, the appearance stream must specify any transparency. (However, if the viewer
regenerates the annotation’s appearance stream, it may incorporate the CA value
into the stream’s content.)
The implicit blend mode is Normal.
Default value: 1.0.
(Optional; PDF 1.5) Text representing a short description of the subject being
addressed by the annotation.
Specifies the annotation flags.
If set, do not display the annotation if it does not belong to one of the standard
annotation types and no annotation handler is available. If clear, display such an
unknown annotation using an appearance stream specified by its appearance dictionary,
if any.
(PDF 1.2) If set, do not display or print the annotation or allow it to interact
with the user, regardless of its annotation type or whether an annotation
handler is available. In cases where screen space is limited, the ability to hide
and show annotations selectively can be used in combination with appearance
streams to display auxiliary pop-up information similar in function to online
help systems.
(PDF 1.2) If set, print the annotation when the page is printed. If clear, never
print the annotation, regardless of whether it is displayed on the screen. This
can be useful, for example, for annotations representing interactive pushbuttons,
which would serve no meaningful purpose on the printed page.
(PDF 1.3) If set, do not scale the annotation’s appearance to match the magnification
of the page. The location of the annotation on the page (defined by the
upper-left corner of its annotation rectangle) remains fixed, regardless of the
page magnification. See below for further discussion.
(PDF 1.3) If set, do not rotate the annotation’s appearance to match the rotation
of the page. The upper-left corner of the annotation rectangle remains in a fixed
location on the page, regardless of the page rotation. See below for further discussion.
(PDF 1.3) If set, do not display the annotation on the screen or allow it to
interact with the user. The annotation may be printed (depending on the setting
of the Print flag) but should be considered hidden for purposes of on-screen
display and user interaction.
(PDF 1.3) If set, do not allow the annotation to interact with the user. The
annotation may be displayed or printed (depending on the settings of the
NoView and Print flags) but should not respond to mouse clicks or change its
appearance in response to mouse motions.
Note: This flag is ignored for widget annotations; its function is subsumed by
the ReadOnly flag of the associated form field.
(PDF 1.4) If set, do not allow the annotation to be deleted or its properties
(including position and size) to be modified by the user. However, this flag does
not restrict changes to the annotation’s contents, such as the value of a form
field.
(PDF 1.5) If set, invert the interpretation of the NoView flag for certain events.
A typical use is to have an annotation that appears only when a mouse cursor is
held over it.
Represents the annotations array of a page.
Summary description for PdfArray.
Initializes a new instance of this class.
Gets the collection containing the elements of this object.
Represents the elements of an PdfArray.
Creates a shallow copy of this object.
Moves this instance to another dictionary during object type transformation.
Converts the specified value to float.
If the value not exists, the function returns 0.
If the value is not convertible, the function throws an InvalidCastException.
If the index is out ouf range, the function throws an ArgumentOutOfRangeException.
Adds the specified annotation.
The annotation.
Gets the number of annotations in this collection.
Gets the at the specified index.
Gets the page the annotations belongs to.
Represents a direct boolean value.
Returns 'false' or 'true'.
Writes 'true' or 'false'.
Summary description for PdfCatalogDictionary.
Dispatches PrepareForSave to the objects that need it.
Implementation of PdfDocument.Outlines.
Gets the KeysMeta of this dictionary type.
Predefined keys of this dictionary.
(Required) The type of PDF object that this dictionary describes;
must be CatalogDictionary for the catalog dictionary.
(Optional; PDF 1.4) The version of the PDF specification to which the document
conforms (for example, 1.4) if later than the version specified in the file’s header.
If the header specifies a later version, or if this entry is absent, the document
conforms to the version specified in the header. This entry enables a PDF producer
application to update the version using an incremental update.
(Required; must be an indirect reference) The page tree node that is the root of
the document’s page tree.
(Optional; PDF 1.3) A number tree defining the page labeling for the document.
The keys in this tree are page indices; the corresponding values are page label dictionaries.
Each page index denotes the first page in a labeling range to which the specified page
label dictionary applies. The tree must include a value for pageindex 0.
(Optional; PDF 1.2) The document’s name dictionary.
(Optional; PDF 1.1; must be an indirect reference) A dictionary of names and
corresponding destinations.
(Optional; PDF 1.2) A viewer preferences dictionary specifying the way the document
is to be displayed on the screen. If this entry is absent, applications should use
their own current user preference settings.
(Optional) A name object specifying the page layout to be used when the document is
opened:
SinglePage - Display one page at a time.
OneColumn - Display the pages in one column.
TwoColumnLeft - Display the pages in two columns, with oddnumbered pages on the left.
TwoColumnRight - Display the pages in two columns, with oddnumbered pages on the right.
TwoPageLeft - (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left
TwoPageRight - (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right.
(Optional) A name object specifying how the document should be displayed when opened:
UseNone - Neither document outline nor thumbnail images visible.
UseOutlines - Document outline visible.
UseThumbs - Thumbnail images visible.
FullScreen - Full-screen mode, with no menu bar, windowcontrols, or any other window visible.
UseOC - (PDF 1.5) Optional content group panel visible.
UseAttachments (PDF 1.6) Attachments panel visible.
Default value: UseNone.
(Optional; must be an indirect reference) The outline dictionary that is the root
of the document’s outline hierarchy.
(Optional; PDF 1.1; must be an indirect reference) An array of thread dictionaries
representing the document’s article threads.
(Optional; PDF 1.1) A value specifying a destination to be displayed or an action to be
performed when the document is opened. The value is either an array defining a destination
or an action dictionary representing an action. If this entry is absent, the document
should be opened to the top of the first page at the default magnification factor.
(Optional; PDF 1.4) An additional-actions dictionary defining the actions to be taken
in response to various trigger events affecting the document as a whole.
(Optional; PDF 1.1) A URI dictionary containing document-level information for URI
(uniform resource identifier) actions.
(Optional; PDF 1.4; must be an indirect reference) A metadata stream
containing metadata for the document.
(Optional; PDF 1.3) The document’s structure tree root dictionary.
(Optional; PDF 1.4) A mark information dictionary containing information
about the document’s usage of Tagged PDF conventions.
(Optional; PDF 1.4) A language identifier specifying the natural language for all
text in the document except where overridden by language specificationsfor structure
elements or marked content. If this entry is absent, the language is considered unknown.
(Optional; PDF 1.3) A Web Capture information dictionary containing state information
used by the Acrobat Web Capture (AcroSpider) plugin extension.
(Optional; PDF 1.4) An array of output intent dictionaries describing the color
characteristics of output devices on which the document might be rendered.
(Optional; PDF 1.4) A page-piece dictionary associated with the document.
(Optional; PDF 1.5; required if a document contains optional content) The document’s
optional content properties dictionary.
(Optional; PDF 1.5) A permissions dictionary that specifies user access permissions
for the document.
(Optional; PDF 1.5) A dictionary containing attestations regarding the content of a
PDF document, as it relates to the legality of digital signatures.
Gets the KeysMeta for these keys.
Represents the content of a page. PDFsharp supports only one content stream per page.
If an imported page has an array of content streams, the streams are concatenated to
one single stream.
Gets the KeysMeta of this dictionary type.
Predefined keys of this dictionary.
Common keys for all streams.
Base class for all PDF stream objects.
The dictionary the stream belongs to.
A .NET string can contain char(0) as a valid character.
Moves this instance to another dictionary during object type transformation.
Returns the strem content a raw string.
Get the bytes of the stream as they are, i.e. if one or more filters exists the bytes are
not unfiltered.
Gets the value of the stream unfiltered. The stream content is not modified by this operation.
Common keys for all streams.
(Required) The number of bytes from the beginning of the line following the keyword
stream to the last byte just before the keywordendstream. (There may be an additional
EOL marker, preceding endstream, that is not included in the count and is not logically
part of the stream data.)
(Optional) The name of a filter to be applied in processing the stream data found between
the keywords stream and endstream, or an array of such names. Multiple filters should be
specified in the order in which they are to be applied.
(Optional) A parameter dictionary or an array of such dictionaries, used by the filters
specified by Filter. If there is only one filter and that filter has parameters, DecodeParms
must be set to the filter’s parameter dictionary unless all the filter’s parameters have
their default values, in which case the DecodeParms entry may be omitted. If there are
multiple filters and any of the filters has parameters set to nondefault values, DecodeParms
must be an array with one entry for each filter: either the parameter dictionary for that
filter, or the null object if that filter has no parameters (or if all of its parameters have
their default values). If none of the filters have parameters, or if all their parameters
have default values, the DecodeParms entry may be omitted.
(Optional; PDF 1.2) The file containing the stream data. If this entry is present, the bytes
between stream and endstream are ignored, the filters are specified by FFilter rather than
Filter, and the filter parameters are specified by FDecodeParms rather than DecodeParms.
However, the Length entry should still specify the number of those bytes. (Usually, there are
no bytes and Length is 0.)
(Optional; PDF 1.2) The name of a filter to be applied in processing the data found in the
stream’s external file, or an array of such names. The same rules apply as for Filter.
(Optional; PDF 1.2) A parameter dictionary, or an array of such dictionaries, used by the
filters specified by FFilter. The same rules apply as for DecodeParms.
Optional; PDF 1.5) A non-negative integer representing the number of bytes in the decoded
(defiltered) stream. It can be used to determine, for example, whether enough disk space is
available to write a stream to a file.
This value should be considered a hint only; for some stream filters, it may not be possible
to determine this value precisely.
(Required for Type 1 and TrueType fonts) The length in bytes of the clear-text portion
of the Type 1 font program (see below), or the entire TrueType font program, after it
has been decoded using the filters specified by the stream’s Filter entry, if any.
(Required for Type 1 fonts) The length in bytes of the encrypted portion of the Type 1
font program (see below) after it has been decoded using the filters specified by the
stream’s Filter entry.
(Required for Type 1 fonts) The length in bytes of the fixed-content portion of the
Type 1 font program (see below) after it has been decoded using the filters specified
by the stream’s Filter entry. If Length3 is 0, it indicates that the 512 zeros and
cleartomark have not been included in the FontFile font program and must be added.
(Required if referenced from FontFile3; PDF 1.2) A name specifying the format of the
embedded font program. The name must be Type1C for Type 1 compact fonts,
CIDFontType0C for Type 0 compact CIDFonts, or OpenType for OpenType fonts.
When additional font formats are added to PDF, more values will be defined for
Subtype.
(Optional; PDF 1.4) A metadata stream containing metadata for the embedded font
program (see Section 10.2.2, “Metadata Streams”).
Gets the KeysMeta for these keys.
Represents an array of PDF content streams of a page.
Appends a new content stream and returns it.
Represents a direct date value.
Returns the value in the PDF date format.
Writes the value in the PDF date format.
Parses a PDF date string.
Returns the type of the object to be created as value of the specified key.
Gets the value for the specified key. If the value does not exists, it is optionally created.
Sets the specified name value.
If the value doesn't start with a slash, it is added automatically.
Converts the specified value to a name.
If the value not exists, the function returns the empty string.
Converts the specified value to integer.
If the value not exists, the function returns 0.
If the value is not convertible, the function throws an InvalidCastException.
Converts the specified value to String.
If the value not exists, the function returns the empty string.
Converts the specified value to PdfRectangle.
If the value not exists, the function returns an empty rectangle.
If the value is not convertible, the function throws an InvalidCastException.
Gets all keys currently in use in this dictionary as an array
of PdfName objects.
Gets or sets an entry in the dictionary. The specified key must
be a valid PDF name starting with a slash '/'. This property
provides full access to the elements of the PDF dictionary.
Wrong use can lead to errors or corrupt PDF files.
Gets or sets an entry in the dictionary identified by a PdfName object.
Summary description for PdfDocument.
Creates a new page and adds it to this document.
Dispatches PrepareForSave to the objects that need it.
Gets the root of the outline (or bookmark) tree.
Get the pages dictionary.
Gets the PdfCatalogDictionary of the current document.
Gets the cross-reference table of the current document.
Gets the document ExtGState table that holds all form state objects
used in the current document.
Gets the document font table that holds all fonts used in the current document.
Gets the document gdiImage table that holds all images used in the
current document.
Summary description for PdfDocumentInformationDictionary.
Gets or sets the creator application.
Gets the producer application.
Gets or sets the creation date.
Gets or sets the modification date.
Gets the KeysMeta of this dictionary type.
Predefined keys of this dictionary.
(Optional; PDF 1.1) The document’s title.
(Optional) The name of the person who created the document.
(Optional; PDF 1.1) The subject of the document.
(Optional; PDF 1.1) Keywords associated with the document.
(Optional) If the document was converted to PDF from another format,
the name of the application (for example, empira MigraDoc®) that created the
original document from which it was converted.
(Optional) If the document was converted to PDF from another format,
the name of the application (for example, this library) that converted it to PDF.
(Optional) The date and time the document was created, in human-readable form.
(Required if PieceInfo is present in the document catalog; otherwise optional; PDF 1.1)
The date and time the document was most recently modified, in human-readable form.
(Optional; PDF 1.3) A name object indicating whether the document has been modified
to include trapping information.
Gets the KeysMeta for these keys.
Represents a set of document generation options.
Does not embed fonts.
Embeds only used subsets of the fonts.
Fully embeds fonts.
Represents an extended graphics state object.
Gets the KeysMeta of this dictionary type.
Common keys for all streams.
(Optional) The type of PDF object that this dictionary describes;
must be ExtGState for a graphics state parameter dictionary.
(Optional; PDF 1.3) The line width (see “Line Width” on page 185).
(Optional; PDF 1.3) The line cap style.
(Optional; PDF 1.3) The line join style.
(Optional; PDF 1.3) The miter limit.
(Optional; PDF 1.3) The line dash pattern, expressed as an array of the form
[dashArray dashPhase], where dashArray is itself an array and dashPhase is an integer.
(Optional; PDF 1.3) The name of the rendering intent.
(Optional) A flag specifying whether to apply overprint. In PDF 1.2 and earlier,
there is a single overprint parameter that applies to all painting operations.
Beginning with PDF 1.3, there are two separate overprint parameters: one for stroking
and one for all other painting operations. Specifying an OP entry sets both parameters
unless there is also an op entry in the same graphics state parameter dictionary, in
which case the OP entry sets only the overprint parameter for stroking.
(Optional; PDF 1.3) A flag specifying whether to apply overprintfor painting operations
other than stroking. If this entry is absent, the OP entry, if any, sets this parameter.
(Optional; PDF 1.3) The overprint mode.
(Optional; PDF 1.3) An array of the form [font size], where font is an indirect
reference to a font dictionary and size is a number expressed in text space units.
These two objects correspond to the operands of the Tf operator; however,
the first operand is an indirect object reference instead of a resource name.
(Optional) The black-generation function, which maps the interval [0.0 1.0]
to the interval [0.0 1.0].
(Optional; PDF 1.3) Same as BG except that the value may also be the name Default,
denoting the black-generation function that was in effect at the start of the page.
If both BG and BG2 are present in the same graphics state parameter dictionary,
BG2 takes precedence.
(Optional) The undercolor-removal function, which maps the interval
[0.0 1.0] to the interval [-1.0 1.0].
(Optional; PDF 1.3) Same as UCR except that the value may also be the name Default,
denoting the undercolor-removal function that was in effect at the start of the page.
If both UCR and UCR2 are present in the same graphics state parameter dictionary,
UCR2 takes precedence.
(Optional; PDF 1.4) The current stroking alpha constant, specifying the constant
shape or constant opacity value to be used for stroking operations in the transparent
imaging model.
(Optional; PDF 1.4) Same as CA, but for nonstroking operations.
(Optional; PDF 1.4) The alpha source flag (“alpha is shape”), specifying whether
the current soft mask and alpha constant are to be interpreted as shape values (true)
or opacity values (false).
(Optional; PDF 1.4) The text knockout flag, which determines the behavior of
overlapping glyphs within a text object in the transparent imaging model.
Gets the KeysMeta for these keys.
Contains all used ExtGState objects of a document.
Base class for FontTable, ImageTable, FormXObjectTable etc.
Maps from alpha values (range "0" to "1000") to PdfExtendedGraphicsStateDictionary objects.
Initializes a new instance of this class, which is a singleton for each document.
Gets a PdfExtendedGraphicsStateDictionary with the key 'CA' set to the specified alpha value.
Gets a PdfExtendedGraphicsStateDictionary with the key 'ca' set to the specified alpha value.
A PDF font descriptor specifies metrics and other attributes of a simple font,
as distinct from the metrics of individual glyphs.
Gets the KeysMeta of this dictionary type.
Predefined keys of this dictionary.
(Required) The type of PDF object that this dictionary describes; must be
FontDescriptor for a font trueTypeDescriptor.
(Required) The PostScript name of the font. This name should be the same as the
value of BaseFont in the font or DESCENDANT dictionary that refers to this font trueTypeDescriptor.
(Optional; PDF 1.5; strongly recommended for Type 3 fonts in Tagged PDF documents)
A string specifying the preferred font family name. For example, for the font
Times Bold Italic, the FontFamily is Times.
(Optional; PDF 1.5; strongly recommended for Type 3 fonts in Tagged PDF documents)
The font stretch value. It must be one of the following names (ordered from
narrowest to widest): UltraCondensed, ExtraCondensed, Condensed, SemiCondensed,
Normal, SemiExpanded, Expanded, ExtraExpanded or UltraExpanded.
Note: The specific interpretation of these values varies from font to font.
For example, Condensed in one font may appear most similar to Normal in another.
(Optional; PDF 1.5; strongly recommended for Type 3 fonts in Tagged PDF documents)
The weight (thickness) component of the fully-qualified font name or font specifier.
The possible values are 100, 200, 300, 400, 500, 600, 700, 800, or 900, where each
number indicates a weight that is at least as dark as its predecessor. A value of
400 indicates a normal weight; 700 indicates bold.
Note: The specific interpretation of these values varies from font to font.
For example, 300 in one font may appear most similar to 500 in another.
(Required) A collection of flags defining various characteristics of the font.
(Required, except for Type 3 fonts) A rectangle (see Section 3.8.4, “Rectangles”),
expressed in the glyph coordinate system, specifying the font bounding box. This
is the smallest rectangle enclosing the shape that would result if all of the
glyphs of the font were placed with their origins coincident and then filled.
(Required) The angle, expressed in degrees counterclockwise from the vertical, of
the dominant vertical strokes of the font. (For example, the 9-o’clock position is 90
degrees, and the 3-o’clock position is –90 degrees.) The value is negative for fonts
that slope to the right, as almost all italic fonts do.
(Required, except for Type 3 fonts) The maximum height above the baseline reached
by glyphs in this font, excluding the height of glyphs for accented characters.
(Required, except for Type 3 fonts) The maximum depth below the baseline reached
by glyphs in this font. The value is a negative number.
(Optional) The spacing between baselines of consecutive lines of text.
Default value: 0.
(Required for fonts that have Latin characters, except for Type 3 fonts) The vertical
coordinate of the top of flat capital letters, measured from the baseline.
(Optional) The font’s x height: the vertical coordinate of the top of flat nonascending
lowercase letters (like the letter x), measured from the baseline, in fonts that have
Latin characters. Default value: 0.
(Required, except for Type 3 fonts) The thickness, measured horizontally, of the dominant
vertical stems of glyphs in the font.
(Optional) The thickness, measured vertically, of the dominant horizontal stems
of glyphs in the font. Default value: 0.
(Optional) The average width of glyphs in the font. Default value: 0.
(Optional) The maximum width of glyphs in the font. Default value: 0.
(Optional) The width to use for character codes whose widths are not specified in a
font dictionary’s Widths array. This has a predictable effect only if all such codes
map to glyphs whose actual widths are the same as the value of the MissingWidth entry.
Default value: 0.
(Optional) A stream containing a Type 1 font program.
(Optional; PDF 1.1) A stream containing a TrueType font program.
(Optional; PDF 1.2) A stream containing a font program whose format is specified
by the Subtype entry in the stream dictionary.
(Optional; meaningful only in Type 1 fonts; PDF 1.1) A string listing the character
names defined in a font subset. The names in this string must be in PDF syntax—that is,
each name preceded by a slash (/). The names can appear in any order. The name .notdef
should be omitted; it is assumed to exist in the font subset. If this entry is absent,
the only indication of a font subset is the subset tag in the FontName entry.
Gets the KeysMeta for these keys.
The PDF font descriptor flags.
All glyphs have the same width (as opposed to proportional or variable-pitch
fonts, which have different widths).
Glyphs have serifs, which are short strokes drawn at an angle on the top and
bottom of glyph stems. (Sans serif fonts do not have serifs.)
Font contains glyphs outside the Adobe standard Latin character set. This
flag and the Nonsymbolic flag cannot both be set or both be clear.
Glyphs resemble cursive handwriting.
Font uses the Adobe standard Latin character set or a subset of it.
Glyphs have dominant vertical strokes that are slanted.
Font contains no lowercase letters; typically used for display purposes,
such as for titles or headlines.
Font contains both uppercase and lowercase letters. The uppercase letters are
similar to those in the regular version of the same typeface family. The glyphs
for the lowercase letters have the same shapes as the corresponding uppercase
letters, but they are sized and their proportions adjusted so that they have the
same size and stroke weight as lowercase glyphs in the same typeface family.
Determines whether bold glyphs are painted with extra pixels even at very small
text sizes.
A collection of information that uniquely idendifies a particular
PDF font. Two PDF fonts are equal if and only if their font imageInfo
objects are equal.
Initializes a new instance of PdfFontSelector from an PdfFontDictionary.
Returns a string for diagnostic purposes only.
Gets the (generated) resource name of the font. In our own PDF
files equal fonts share the same resource name in all contents
streams.
TrueType with WinAnsi encoding.
TrueType with Identity-H encoding (unicode).
Contains all used fonts of a document.
Map from PdfFontInfo to PdfFontDictionary.
Initializes a new instance of this class, which is a singleton for each document.
Gets a PdfFontDictionary from an Drawing.PdfFontDictionary.
If no PdfFontDictionary already exists, a new one is created.
Gets the FontDescriptor identified by the specified FontDescriptorInfo.
If no such objects exists, a new FontDescriptor is created and
added to the stock.
Represents a Type0 composite font with Identity-H encoding.
Contains PdfCIDFontType2Dictionary and PdfToUnicodeCMapDictionary.
Gets the KeysMeta of this dictionary type.
Predefined keys of this dictionary.
(Required) The type of PDF object that this dictionary describes;
must be Font for a font dictionary.
(Required) The type of font; must be Type0 for a Type 0 font.
(Required) The PostScript name of the font. In principle, this
is an arbitrary name, since there is no font program
associated directly with a Type 0 font dictionary. The
conventions described here ensure maximum compatibility with
existing Acrobat products. If the descendant is a Type 0
DESCENDANT, this name should be the concatenation of the
DESCENDANT’s BaseFont name, a hyphen, and the CMap name given in
the Encoding entry (or the CMapName entry in the CMap). If the
descendant is a Type 2 DESCENDANT, this name should be the same
as the DESCENDANT’s BaseFont name.
(Required) The name of a predefined CMap, or a stream
containing a CMap that maps character codes to font numbers
and CIDs. If the descendant is a Type 2 DESCENDANT whose
associated TrueType font program is not embedded in the PDF
file, the Encoding entry must be a predefined CMap name (see
“Glyph Selection in CIDFonts” on page 408).
(Required) A one-element array specifying the DESCENDANT
dictionary that is the descendant of this Type 0 font.
(Optional; PDF 1.2) A stream containing a CMap file that maps
character codes to Unicode values.
Gets the KeysMeta for these keys.
Represents a CIDFontType2 descendant font.
Initializes a new instance of PdfFontDictionary from an PdfFontDictionary.
Gets a PdfArray containing all pages of this document. The array must not be modified.
Gets the KeysMeta of this dictionary type.
Predefined keys of this dictionary.
(Required) The type of PDF object that this dictionary
describes; must be Font for a font dictionary.
(Required) The type of font; CIDFontType0 or CIDFontType2.
(Required) The PostScript name of the font. For Type 0
CIDFonts, this is usually the value of the CIDFontName entry
in the font program. For Type 2 CIDFonts, it is derived the
same way as for a simple TrueType font; see Section 5.5.2,
“TrueType Fonts.” In either case, the name can have a subset
prefix if appropriate; see Section 5.5.3, “Font Subsets.”
(Required) A dictionary containing entries that define the
character collection of the font. See Table 5.13 on page
406.
(Required; must be an indirect reference) A font descriptor
describing the font’s default metrics other than its glyph
widths (see Section 5.7, “Font Descriptors”).
(Optional) The default width for glyphs in the font (see
“Glyph Metrics in CIDFonts” on page 409). Default value: 1000.
(Optional) A description of the widths for the glyphs in the
font. The array’s elements have a variable format that can
specify individual widths for consecutive CIDs or one width
for a range of CIDs (see “Glyph Metrics in CIDFonts” on page
409). Default value: none (the DW value is used for all
glyphs).
(Optional; applies only to CIDFonts used for vertical writing)
An array of two numbers specifying the default metrics for
vertical writing (see “Glyph Metrics in CIDFonts” on page 409).
Default value: [880 ?1000].
(Optional; applies only to CIDFonts used for vertical writing)
A description of the metrics for vertical writing for the
glyphs in the font (see “Glyph Metrics in CIDFonts” on page
409). Default value: none (the DW2 value is used for all
glyphs).
(Optional; Type 2 CIDFonts only) A specification of the
mapping from CIDs to glyph indices. If the value is a stream,
the bytes in the stream contain the mapping from CIDs to glyph
indices: the glyph index for a particular CID value c is a
2-byte value stored in bytes 2 ? c and 2 ? c + 1, where the
first byte is the high-order byte. If the value of CIDToGIDMap
is a name, it must be Identity, indicating that the mapping
between CIDs and glyph indices is the identity mapping.
Default value: Identity.
This entry may appear only in a Type 2 font whose
associated True-Type font program is embedded in the PDF file.
Gets the KeysMeta for these keys.
Gets the KeysMeta of this dictionary type.
Predefined keys of this dictionary.
(Required) A string identifying the issuer of the character
collection—for example, Adobe. For information about assigning
a registry identifier, contact the Adobe Solutions Network or
consult the ASN Web site (see the Bibliography).
(Required) A string that uniquely names the character
collection within the specified registry—for example, Japan1.
(Required) The supplement number of the character collection.
An original character collection has a supplement number of 0.
Whenever additional CIDs are assigned in a character
collection, the supplement number is increased. Supplements do
not alter the ordering of existing CIDs in the character
collection. This value is not used in determining
compatibility between character collections.
Gets the KeysMeta for these keys.
Represents a ToUnicode map for composite font.
http://partners.adobe.com/public/developer/en/acrobat/5411.ToUnicode.pdf
Creates the ToUnicode map from the CMapInfo.
Summary description for PdfHeader.
If a PDF file contains binary data, as most do (see Section 3.1,
“Lexical Conventions”), it is recommended that the header line be
immediately followed by a comment line containing at least four
binary characters—that is, characters whose codes are 128 or
greater. This ensures proper behavior of file transfer applications
that inspect data near the beginning of a file to determine whether
to treat the file’s contents as text or as binary.
3.4.1
Returns the file header of the PDF file.
The version of the PDF specification.
The file header of the PDF file.
Represents an PdfImageDictionary
Base class for all PDF external objects.
Predefined keys of this dictionary.
Initializes a new instance of PdfImageDictionary from an PdfImage.
Returns 'Image'.
Creates the keys for a JPEG image.
Creates the keys for a FLATE image.
Reads images that are returned from GDI+ without color palette.
4 (32bpp RGB), 3 (24bpp RGB, 32bpp ARGB)
8
true (ARGB), false (RGB)
Gets the underlying Drawing.PdfImageDictionary object.
Common keys for all streams.
(Optional) The type of PDF object that this dictionary describes;
if present, must be XObject for an image XObject.
(Required) The type of XObject that this dictionary describes;
must be Drawingimage for an image XObject.
(Required) The width of the image, in samples.
(Required) The height of the image, in samples.
(Required for images, except those that use the JPXDecode filter; not allowed for image masks)
The color space in which image samples are specified; it can be any type of color space except
Pattern. If the image uses the JPXDecode filter, this entry is optional:
• If ColorSpace is present, any color space specifications in the JPEG2000 data are ignored.
• If ColorSpace is absent, the color space specifications in the JPEG2000 data are used.
The Decode array is also ignored unless ImageMask is true.
(Required except for image masks and images that use the JPXDecode filter)
The number of bits used to represent each color component. Only a single value may be specified;
the number of bits is the same for all color components. Valid values are 1, 2, 4, 8, and
(in PDF 1.5) 16. If ImageMask is true, this entry is optional, and if specified, its value
must be 1.
If the image stream uses a filter, the value of BitsPerComponent must be consistent with the
size of the data samples that the filter delivers. In particular, a CCITTFaxDecode or JBIG2Decode
filter always delivers 1-bit samples, a RunLengthDecode or DCTDecode filter delivers 8-bit samples,
and an LZWDecode or FlateDecode filter delivers samples of a specified size if a predictor function
is used.
If the image stream uses the JPXDecode filter, this entry is optional and ignored if present.
The bit depth is determined in the process of decoding the JPEG2000 image.
(Optional; PDF 1.1) The name of a color rendering intent to be used in rendering the image.
Default value: the current rendering intent in the graphics state.
(Optional) A flag indicating whether the image is to be treated as an image mask.
If this flag is true, the value of BitsPerComponent must be 1 and Mask and ColorSpace should
not be specified; unmasked areas are painted using the current nonstroking color.
Default value: false.
(Optional except for image masks; not allowed for image masks; PDF 1.3)
An image XObject defining an image mask to be applied to this image, or an array specifying
a range of colors to be applied to it as a color key mask. If ImageMask is true, this entry
must not be present.
(Optional) An array of numbers describing how to map image samples into the range of values
appropriate for the image’s color space. If ImageMask is true, the array must be either
[0 1] or [1 0]; otherwise, its length must be twice the number of color components required
by ColorSpace. If the image uses the JPXDecode filter and ImageMask is false, Decode is ignored.
Default value: see “Decode Arrays”.
(Optional) A flag indicating whether image interpolation is to be performed.
Default value: false.
(Optional; PDF 1.3) An array of alternate image dictionaries for this image. The order of
elements within the array has no significance. This entry may not be present in an image
XObject that is itself an alternate image.
(Optional; PDF 1.4) A subsidiary image XObject defining a soft-mask image to be used as a
source of mask shape or mask opacity values in the transparent imaging model. The alpha
source parameter in the graphics state determines whether the mask values are interpreted as
shape or opacity. If present, this entry overrides the current soft mask in the graphics state,
as well as the image’s Mask entry, if any. (However, the other transparencyrelated graphics
state parameters—blend mode and alpha constant—remain in effect.) If SMask is absent, the
image has no associated soft mask (although the current soft mask in the graphics state may
still apply).
(Optional for images that use the JPXDecode filter, meaningless otherwise; PDF 1.5)
A code specifying how soft-mask information encoded with image samples should be used:
0 If present, encoded soft-mask image information should be ignored.
1 The image’s data stream includes encoded soft-mask values. An application can create
a soft-mask image from the information to be used as a source of mask shape or mask
opacity in the transparency imaging model.
2 The image’s data stream includes color channels that have been preblended with a
background; the image data also includes an opacity channel. An application can create
a soft-mask image with a Matte entry from the opacity channel information to be used as
a source of mask shape or mask opacity in the transparency model. If this entry has a
nonzero value, SMask should not be specified.
Default value: 0.
(Required in PDF 1.0; optional otherwise) The name by which this image XObject is
referenced in the XObject subdictionary of the current resource dictionary.
(Required if the image is a structural content item; PDF 1.3) The integer key of the
image’s entry in the structural parent tree.
(Optional; PDF 1.3; indirect reference preferred) The digital identifier of the image’s
parent Web Capture content set.
(Optional; PDF 1.2) An OPI version dictionary for the image. If ImageMask is true,
this entry is ignored.
(Optional; PDF 1.4) A metadata stream containing metadata for the image.
(Optional; PDF 1.5) An optional content group or optional content membership dictionary,
specifying the optional content properties for this image XObject. Before the image is
processed, its visibility is determined based on this entry. If it is determined to be
invisible, the entire image is skipped, as if there were no Do operator to invoke it.
Helper class for creating bitmap masks (8 pels per byte).
Creates a bitmap mask.
Starts a new line.
Adds a pel to the current line.
Adds a pel from an alpha mask value.
Returns the bitmap mask that will be written to PDF.
An object that uniquely identifies a particular PdfImageDictionary.
Used for identical image caching.
Creates a new instance of the PdfImageInfo object used for hashing
equivalent images.
The image.
The source rectangle in PIXELS.
Computes a hash value based on the binary image data and the source
rectangle. These two elements uniquely identify a PdfImageInfo.
The image.
The source rectangle from the OriginalImage in PIXELS.
Specifies whether the entire image should be drawn. This is used
to draw the image directly, instead of creating a new bitmap to
draw a portion of the image.
Contains all used images of a document.
Map from PdfImageInfo to PdfImageDictionary.
Initializes a new instance of this class, which is a singleton for each document.
Gets a PdfImageDictionary from an PdfImageDictionary.
If no PdfImageDictionary already exists, a new one is created.
Summary description for PdfInteger.
Writes the integer as string.
Represents a link annotation.
Initializes a new instance of the class.
Initializes a new instance of the class.
Gets the KeysMeta of this dictionary type.
Predefined keys of this dictionary.
(Optional; not permitted if an A entry is present) A destination to be displayed
when the annotation is activated.
(Optional; PDF 1.2) The annotation’s highlighting mode, the visual effect to be
used when the mouse button is pressed or held down inside its active area:
N (None) No highlighting.
I (Invert) Invert the contents of the annotation rectangle.
O (Outline) Invert the annotation’s border.
P (Push) Display the annotation as if it were being pushed below the surface of the page.
Default value: I.
Note: In PDF 1.1, highlighting is always done by inverting colors inside the annotation rectangle.
(Optional; PDF 1.3) A URI action formerly associated with this annotation. When Web
Capture changes an annotation from a URI to a go-to action, it uses this entry to save
the data from the original URI action so that it can be changed back in case the target page for
the go-to action is subsequently deleted.
Gets the KeysMeta for these keys.
Represents text that is written 'as it is' into the PDF stream.
Initializes a new instance with the specified string.
3.2.4
A name object is an atomic symbol uniquely defined by a sequence of
characters. Uniquely defined means that any two name objects made up of
the same sequence of characters are identically the same object. Atomic
means that a name has no internal structure; although it is defined by
a sequence of characters, those characters are not considered elements
of the name. A slash character (/) introduces a name. The slash is not
part of the name but is a prefix indicating that the following sequence
of characters constitutes a name. There can be no white-space
characters between the slash and the first character in the name. The
name may include any regular characters, but not delimiter or
white-space characters (see Section 3.1, “Lexical Conventions”).
Uppercase and lowercase letters are considered distinct: /A and /a are
different names.
Returns the name. The string always begins with a slash.
Returns the value of the PdfName. This class must behave like a
value type. Therefore it cannot be changed (like System.String).
Implements a comparer that compares PdfName objects.
Some categories of objects in a PDF file can be referred to by name
rather than by object reference. The correspondence between names and
objects is established by the document’s name dictionary (PDF 1.2),
located by means of the Names entry in the document’s catalog
(see Section 3.6.1, “Document Catalog”). Each entry in this dictionary
designates the root of a name tree (Section 3.8.5, “Name Trees”)
defining names for a particular category of objects.
Gets the KeysMeta of this dictionary type.
(Optional; PDF 1.3) A name tree mapping name strings to
document-level JavaScript actions (see “JavaScriptNameTree Actions”
on page 709).
Gets the KeysMeta for these keys.
A name tree is constructed of nodes, each of which is a dictionary
object. Table 3.33 shows the entries in a node dictionary.
The nodes are of three kinds, depending on the specific entries they
contain. The tree always has exactly one root node, which contains a
single entry: either Kids or Names but not both. If the root node has a
Names entry, it is the only node in the tree. If it has a Kids entry,
each of the remaining nodes is either an intermediate node, containing
a Limitsentry and a Kids entry, or a leaf node, containing a Limits
entry and a Namesentry.
Gets the KeysMeta of this dictionary type.
(Root and leaf nodes only; required in leaf nodes; present in the
root node if and only if Kidsis not present) An array of the form
[ key1 value1 key2 value2 … keyn valuen ] where each keyi is a
string and the corresponding valuei is the object associated with
that key. The keys are sorted in lexical order, as described below.
Gets the KeysMeta for these keys.
Base class for direct number values (not yet used, maybe superfluous).
3.2.9 Indirect Objects
Any object in a PDF file may be labeled as an indirect object. This
gives the object a unique object identifier by which other objects can
refer to it (for example, as an element of an array or as the value of
a dictionary entry). The object identifier consists of two parts:
• A positive integer object number. Indirect objects are often numbered
sequentially within a PDF file, but this is not required; object
numbers may be assigned in any arbitrary order.
• A non-negative integer generation number. In a newly created file,
all indirect objects have generation numbers of 0. Nonzero generation
numbers may be introduced when the file is later updated; see Sections
3.4.3, “Cross-Reference Table,” and 3.4.5, “Incremental Updates.”
Together, the combination of an object number and a generation number
uniquely identifies an indirect object. The object retains the same
object number and generation number throughout its existence, even if
its value is modified.
Represents the empty object identifier.
Indicates whether this object is an empty object identifier.
Represents an outline item in the outlines tree. An outline is also knows as a bookmark.
Initializes a new instance of the class.
Initializes a new instance of the class.
The document.
Creates key/values pairs according to the object structure.
The total number of open descendants at all lower levels.
Gets or sets the title.
Gets or sets the destination page.
Gets or sets the destination left coordinate on the destination page
Gets or sets the destination top coordinate on the destination page
Gets or sets whether the outline item is opened (or expanded).
Gets or sets the style.
Gets or sets the color of the text.
The color of the text.
Gets the outline collection of this node.
Gets the KeysMeta of this dictionary type.
Represents a collection of outlines.
Adds the specified outline.
Gets the index of the specified outline.
Returns an enumerator that iterates through a collection.
Indicates whether the outline has at least one entry.
Gets the number of entries in this collection.
Gets the at the specified index.
Predefined keys of this dictionary.
(Optional) The type of PDF object that this dictionary describes; if present,
must be Outlines for an outline dictionary.
(Required) The text to be displayed on the screen for this item.
(Required; must be an indirect reference) The parent of this item in the outline hierarchy.
The parent of a top-level item is the outline dictionary itself.
(Required for all but the first item at each level; must be an indirect reference)
The previous item at this outline level.
(Required for all but the last item at each level; must be an indirect reference)
The next item at this outline level.
(Required if the item has any descendants; must be an indirect reference)
The first of this item’s immediate children in the outline hierarchy.
(Required if the item has any descendants; must be an indirect reference)
The last of this item’s immediate children in the outline hierarchy.
(Required if the item has any descendants) If the item is open, the total number of its
open descendants at all lower levels of the outline hierarchy. If the item is closed, a
negative integer whose absolute value specifies how many descendants would appear if the
item were reopened.
(Optional; not permitted if an A entry is present) The destination to be displayed when this
item is activated.
(Optional; not permitted if an A entry is present) The destination to be displayed when
this item is activated.
(Optional; PDF 1.3; must be an indirect reference) The structure element to which the item
refers.
Note: The ability to associate an outline item with a structure element (such as the beginning
of a chapter) is a PDF 1.3 feature. For backward compatibility with earlier PDF versions, such
an item should also specify a destination (Dest) corresponding to an area of a page where the
contents of the designated structure element are displayed.
(Optional; PDF 1.4) An array of three numbers in the range 0.0 to 1.0, representing the
components in the DeviceRGB color space of the color to be used for the outline entry’s text.
Default value: [0.0 0.0 0.0].
(Optional; PDF 1.4) A set of flags specifying style characteristics for displaying the outline
item’s text. Default value: 0.
Gets the KeysMeta for these keys.
Specifies the font style for the outline (bookmark) text.
Regular font.
Italic font.
Bold font.
Bold and italic font.
Summary description for PdfPageDictionary.
The content stream currently used by an PdfGraphics object for rendering.
Initializes a new page. The page must be added to a document before
it can be used.
Gets the resource name of the specified font within this page.
Gets the resource name of the specified gdiImage within this page.
Adds an intra document link.
The rect.
The destination page.
Adds a link to the Web.
The rect.
The URL.
Adds a link to a file.
The rect.
Name of the file.
Gets or sets the width of the page. If orientation is Landscape, this function applies to
the height.
Gets or sets the height of the page. If orientation is Landscape, this function applies to
the width.
Gets or sets one of the predefined standard sizes like.
Gets or sets the orientation of the page. The default value PageOrientation.Portrait.
If an imported page has a /Rotate value that satisfys the formula 90 + n * 180 the
orientation is set to PageOrientation.Landscape.
Gets or sets the PdfDocument this page belongs to.
Gets or sets the media box directly. XGrahics is not prepared to
work with a media box with an origin other than (0,0).
Gets the array of content streams of the page.
Gets the annotations array of this page.
Gets the KeysMeta of this dictionary type.
Specifies the orientation of a page.
The default page orientation.
The width and height of the page are reversed.
Predefined keys of this dictionary.
Predefined keys common to PdfPageDictionary and PdfPagesDictionary.
(Required; inheritable) A dictionary containing any resources required by the page.
If the page requires no resources, the value of this entry should be an empty dictionary.
Omitting the entry entirely indicates that the resources are to be inherited from an
ancestor node in the page tree.
(Required; inheritable) A rectangle, expressed in default user space units, defining the
boundaries of the physical medium on which the page is intended to be displayed or printed.
(Optional; inheritable) A rectangle, expressed in default user space units, defining the
visible region of default user space. When the page is displayed or printed, its contents
are to be clipped (cropped) to this rectangle and then imposed on the output medium in some
implementationdefined manner. Default value: the value of MediaBox.
(Optional; inheritable) The number of degrees by which the page should be rotated clockwise
when displayed or printed. The value must be a multiple of 90. Default value: 0.
(Required) The type of PDF object that this dictionary describes;
must be Page for a page object.
(Required; must be an indirect reference)
The page tree node that is the immediate parent of this page object.
(Required if PieceInfo is present; optional otherwise; PDF 1.3) The date and time
when the page’s contents were most recently modified. If a page-piece dictionary
(PieceInfo) is present, the modification date is used to ascertain which of the
application data dictionaries that it contains correspond to the current content
of the page.
(Optional; PDF 1.3) A rectangle, expressed in default user space units, defining the
region to which the contents of the page should be clipped when output in a production
environment. Default value: the value of CropBox.
(Optional; PDF 1.3) A rectangle, expressed in default user space units, defining the
intended dimensions of the finished page after trimming. Default value: the value of
CropBox.
(Optional; PDF 1.3) A rectangle, expressed in default user space units, defining the
extent of the page’s meaningful content (including potential white space) as intended
by the page’s creator. Default value: the value of CropBox.
(Optional; PDF 1.4) A box color information dictionary specifying the colors and other
visual characteristics to be used in displaying guidelines on the screen for the various
page boundaries. If this entry is absent, the application should use its own current
default settings.
(Optional) A content stream describing the contents of this page. If this entry is absent,
the page is empty. The value may be either a single stream or an array of streams. If the
value is an array, the effect is as if all of the streams in the array were concatenated,
in order, to form a single stream. This allows PDF producers to create gdiImage objects and
other resources as they occur, even though they interrupt the content stream. The division
between streams may occur only at the boundaries between lexical tokens but is unrelated
to the page’s logical content or organization. Applications that consume or produce PDF
files are not required to preserve the existing structure of the Contents array.
(Optional; PDF 1.4) A group attributes dictionary specifying the attributes of the page’s
page group for use in the transparent imaging model.
(Optional) A stream object defining the page’s thumbnail gdiImage.
(Optional; PDF 1.1; recommended if the page contains article beads) An array of indirect
references to article beads appearing on the page. The beads are listed in the array in
natural reading order.
(Optional; PDF 1.1) The page’s display duration (also called its advance timing): the
maximum length of time, in seconds, that the page is displayed during presentations before
the viewer application automatically advances to the next page. By default, the viewer does
not advance automatically.
(Optional; PDF 1.1) A transition dictionary describing the transition effect to be used
when displaying the page during presentations.
(Optional) An array of annotation dictionaries representing annotations associated with
the page.
(Optional; PDF 1.2) An additional-actions dictionary defining actions to be performed
when the page is opened or closed.
(Optional; PDF 1.4) A metadata stream containing metadata for the page.
(Optional; PDF 1.3) A page-piece dictionary associated with the page.
(Required if the page contains structural content items; PDF 1.3)
The integer key of the page’s entry in the structural parent tree.
(Optional; PDF 1.3; indirect reference preferred) The digital identifier of
the page’s parent Web Capture content set.
(Optional; PDF 1.3) The page’s preferred zoom (magnification) factor: the factor
by which it should be scaled to achieve the natural display magnification.
(Optional; PDF 1.3) A separation dictionary containing information needed
to generate color separations for the page.
(Optional; PDF 1.5) A name specifying the tab order to be used for annotations
on the page. The possible values are R (row order), C (column order),
and S (structure order).
(Required if this page was created from a named page object; PDF 1.5)
The name of the originating page object.
(Optional; PDF 1.5) A navigation node dictionary representing the first node
on the page.
(Optional; PDF 1.6) A positive number giving the size of default user space units,
in multiples of 1/72 inch. The range of supported values is implementation-dependent.
(Optional; PDF 1.6) An array of viewport dictionaries specifying rectangular regions
of the page.
Gets the KeysMeta for these keys.
Summary description for PdfPagesDictionary.
Creates a new PdfPageDictionary, adds it to this document, and retruns it.
Inserts the specified PdfPageDictionary at the specified position to this document and retruns a may be new PdfPageDictionary object.
The value returned is a new object if the inserted page comes from a foreign document.
Gets the number of pages.
Gets a PdfArray containing all pages of this document. The array must not be modified.
Gets the KeysMeta of this dictionary type.
Predefined keys of this dictionary.
(Required) The type of PDF object that this dictionary describes;
must be Pages for a page tree node.
(Required except in root node; must be an indirect reference)
The page tree node that is the immediate parent of this one.
(Required) An array of indirect references to the immediate children of this node.
The children may be page objects or other page tree nodes.
(Required) The number of leaf nodes (page objects) that are descendants of this node
within the page tree.
Gets the KeysMeta for these keys.
Represents a direct real value.
Returns the real number as string.
Writes the real value with up to three digits.
Represents a PDF rectangle value, that is internally an array with 4 real values.
Represents an empty PdfRectangle.
Initializes a new instance of the PdfRectangle class.
Initializes a new instance of the PdfRectangle class with two points specifying
two diagonally opposite corners. Notice that in contrast to GDI+ convention the
3rd and the 4th parameter specify a point and not a width. This is so much confusing
that this function is for internal use only.
Initializes a new instance of the PdfRectangle class with two points specifying
two diagonally opposite corners.
Initializes a new instance of the PdfRectangle class with the specified location and size.
Initializes a new instance of the PdfRectangle class with the specified PdfRectangle.
Initializes a new instance of the PdfRectangle class with the specified PdfArray.
Tests whether the specified object is a PdfRectangle and has equal coordinates.
Tests whether two structures have equal coordinates.
Tests whether two structures differs in one or more coordinates.
Determines if the specified point is contained within this PdfRectangle.
Determines if the specified point is contained within this PdfRectangle.
Determines if the rectangular region represented by rect is entirely contained within this PdfRectangle.
Determines if the rectangular region represented by rect is entirely contained within this PdfRectangle.
Returns the rectangle as a string in the form «[x1 y1 x2 y2]».
Writes the rectangle.
Tests whether all coordinate are zero.
Gets or sets the x-coordinate of the first corner of this PdfRectangle.
Gets or sets the y-coordinate of the first corner of this PdfRectangle.
Gets or sets the x-coordinate of the second corner of this PdfRectangle.
Gets or sets the y-coordinate of the second corner of this PdfRectangle.
Gets X2 - X1.
Gets Y2 - Y1.
Gets or sets the coordinates of the first point of this PdfRectangle.
Gets or sets the size of this PdfRectangle.
3.4.3
Summary description for PdfReference.
Initializes a new PdfReference instance for the specified indirect
object.
Writes an indirect reference.
Gets a string representing the object identifier.
The byte offset is a 10-digit number, padded with leading zeros if
necessary, giving the number of bytes from the beginning of the
file to the beginning of the object.
Gets or sets the document this object belongs to.
Implements a comparer that compares PdfReference objects by their PdfObjectID.
3.4.3
The cross-reference referenceTable contains information that permits random
access to indirect objects within the file so that the entire file need
not be read to locate any particular object.
Adds a PdfObject to the table.
Returns the next free object number.
Writes the cross-reference table section in the pdf stream.
Gets a cross reference entry from an object identifier.
Base class for all dictionaries that map resource names to objects.
Represents a PDF resource object.
Maps all PDFsharp resources to their local resource names.
Gets the KeysMeta of this dictionary type.
Predefined keys of this dictionary.
(Optional) A dictionary that maps resource names to graphics
state parameter dictionaries.
(Optional) A dictionary that maps each resource name to either the name of a
device-dependent color space or an array describing a color space.
(Optional) A dictionary that maps each resource name to either the name of a
device-dependent color space or an array describing a color space.
(Optional; PDF 1.3) A dictionary that maps resource names to shading dictionaries.
(Optional) A dictionary that maps resource names to external objects.
(Optional) A dictionary that maps resource names to font dictionaries.
(Optional) An array of predefined procedure set names.
(Optional; PDF 1.2) A dictionary that maps resource names to property list
dictionaries for marked content.
Gets the KeysMeta for these keys.
Determines the encoding of a PdfString or PdfStringObject.
Internal wrapper for PdfStringEncoding.
Represents a direct text string value.
Returns the string.
Writes the string DocEncoded.
Gets or sets the string value for encryption purposes.
3.4.4
The trailer of a PDF file enables an application reading the file to
quickly find the cross-reference table and certain special objects.
Initializes a new instance of PdfTrailerDictionary.
(Required; must be an indirect reference)
The catalog dictionary for the PDF document contained in the file.
Gets the KeysMeta of this dictionary type.
Predefined keys of this dictionary.
(Required; must not be an indirect reference) The total number of entries in the file’s
cross-reference table, as defined by the combination of the original section and all
update sections. Equivalently, this value is 1 greater than the highest object number
used in the file.
Note: Any object in a cross-reference section whose number is greater than this value is
ignored and considered missing.
(Present only if the file has more than one cross-reference section; must not be an indirect
reference) The byte offset from the beginning of the file to the beginning of the previous
cross-reference section.
(Required; must be an indirect reference) The catalog dictionary for the PDF document
contained in the file.
(Optional; must be an indirect reference) The document’s information dictionary.
(Optional, but strongly recommended; PDF 1.1) An array of two strings constituting
a file identifier for the file. Although this entry is optional,
its absence might prevent the file from functioning in some workflows
that depend on files being uniquely identified.
(Optional) The byte offset from the beginning of the file of a cross-reference stream.
Gets the KeysMeta for these keys.
Represents a PDF transparency group XObject dictionary.
Initializes a new instance of PdfTransparencyDictionary with default transparency values.
Initializes a new instance of PdfTransparencyDictionary with default transparency values.
Specifies the owner PdfDocument for this PdfTransparencyDictionary instance.
Predefined keys for this dictionary.
(Required) The type of PDF object that this dictionary describes;
must be Group for a group XObject.
(Required) The group subtype, which identifies the type of group whose attributes
this dictionary describes; must be Transparency for a transparency group.
(Required) The group color space, which is used for the following purposes:
- As the color space into which colors are converted when painted into the group;
- As the blending color space in which objects are composited within the group;
- As the color space of the group as a whole when it in turn is painted as an
object onto its backdrop.
(Optional) A flag specifying whether the transparency group is isolated.
If this flag is true, objects within the group are composited against a
fully transparent initial backdrop; if false, they are composited against
the group’s backdrop. The default value is false.
(Optional) A flag specifying whether the transparency group is a knockout group.
If this flag is false, later objects within the group are composited with earlier
ones with which they overlap; if true, they are composited with the group’s initial
backdrop and overwrite any earlier overlapping objects. The default value is false.
Gets or sets HideToolbar.
Gets or sets HideMenubar.
Gets or sets HideWindowUI.
Gets or sets FitWindow.
Gets or sets CenterWindow.
Gets or sets DisplayDocTitle.
Gets or sets Direction.
Gets or sets PrintScaling.
Gets the KeysMeta of this dictionary type.
Predefined keys of this dictionary.
(Required) The type of PDF object that this dictionary describes;
must be ViewerPreferences for the ViewerPreferences dictionary.
(Optional) A flag specifying whether to hide the viewer
application’s tool bars when the document is active.
Default value: false.
(Optional) A flag specifying whether to hide the viewer
application’s menu bar when the document is active.
Default value: false.
(Optional) A flag specifying whether to hide user interface
elements in the document’s window (such as scroll bars and
navigation controls), leaving only the document’s contents
displayed. Default value: false.
(Optional) A flag specifying whether to resize the document’s
window to fit the size of the first displayed page. Default
value: false.
(Optional) A flag specifying whether to position the document’s
window in the center of the screen. Default value: false.
(Optional; PDF 1.4) A flag specifying whether the window’s title
bar should display the document title taken from the Title entry
of the document information dictionary (see Section 10.2.1,
“Document Information Dictionary”). If false, the title bar
should instead display the name of the PDF file containing the
document. Default value: false.
(Optional; PDF 1.3) The predominant reading order for text:
L2R Left to right
R2L Right to left (including vertical writing systems, such
as Chinese, Japanese, and Korean)
This entry has no direct effect on the document’s contents or
page numbering but can be used to determine the relative
positioning of pages when displayed side by side or printed
n-up. Default value: L2R.
Gets the KeysMeta for these keys.
The predominant reading order for text. This entry has no direct effect
on the document’s contents or page numbering but can be used to
determine the relative positioning of pages when displayed side by side
or printed n-up.
Left to right.
Right to left (including vertical writing systems, such as Chinese,
Japanese, and Korean).
The page scaling option to be selected when a print dialog is displayed
for this document.
Indicates that the print dialog should reflect no page scaling.
Indicates that applications should use the current print scaling.
Draws rotated text lines in an image.
In degrees.
The columNumber starts from 1, i.e. 1 = "A", 2 = "B", etc.
Base class for items that contain only sections (Report, Group, SubReport, etc.)
Checks weather the rendering item is completely outside its container.
Adjust the Top and Left positions if the item's location is negative.
Checks whether two rectangles intersect with each other
using the specified measurement unit and precision.
Arranges the items so that they do not overlap each other and
adjusts the position to preserve the minimal space between them.
Compares items to arrange them in Left-Right Top-Bottom order.
Compares items to arrange them in Top-Bottom Left-Right order.
Generates the old school Excel page section content.
For an example, open Excel -> Page Setup -> Header/Footer.
Get the PartTextBox items which will be placed inside the current Page Section part.
Creates the content for a single part in the page section.
Excel page sections are separated in 3 parts (left, center, right).
Translates the content of a single text box to Excel page section formatted text.
Creates the text for the text box.
Creates the format of the text box text.
Compares items to arrange them in Left then Top order.
Modifies the image according to its sizing mode.
Adjust the image to fit the destination rectangle.
If true, the PageHeader is rendered as a Excel page header.
If false, the PageHeader is rendered as a sequence of frozen rows.
If true, the PageFooter section is rendered as a true Excel page Footer.
If false, the PageFooter section is rendered as worksheet cells.
Parameters
Adjusts the horizontal/vertical alignment so that our rotation model is more consistent with the Excel rotation model
Converts the processing textbox value to the format or type that is Excel-compliant.
BACKUP: Save Backup Version of the File (40h)
The BACKUP record specifies whether Microsoft Excel should save backup
versions of a file.
Base class for all BIFF records.
RecordType (2 bytes) + Length Entry (2 bytes) = 4 bytes.
The unique record identifier.
The length of the record in bytes.
Interface for records that have type and data.
= 1 if Microsoft Excel should save a backup version of the file
FontAttributes
FontBoldness
FontScripts
FontUnderlines
DiagonalDirection
HorizontalAlignments
VerticalAlignments
ReadingOrder
TextRotate
BLANK: Cell Value, Blank Cell (201h)
A BLANK record describes an empty cell. The rw field contains the
0-based row number. The col field contains the 0-based column number.
Row
Column
Index to the XF record
BOF: Beginning of File (809h)
The BOF record marks the beginning of the Book stream in the BIFF file.
It also marks the beginning of record groups (or "substreams" of the
Book stream) for sheets in the workbook.
BIFF version.
Type of the following data:
0x0005 = Workbook globals
0x0006 = Visual Basic module
0x0010 = Worksheet
0x0020 = Chart
0x0040 = Macro sheet
0x0100 = Workspace file
Build identifier.
Build year.
File history flags.
Lowest BIFF version.
BOOKBOOL: Workbook Option Flag (DAh)
This record saves a workbook option flag.
=1 if the Save External Link Values option is turned off (Options
dialog box, Calculation tab)
Border
BorderKind
Borders
BorderStyle
BorderWeight
BOUNDSHEET: Sheet Information (85h)
This record stores the sheet name, sheet type, and stream position.
Stream position of the start of the BOF record for the sheet
Option flags
Worksheet name.
Page break structure.
Each element of the rgbrk structure contains three 2-byte integers:
the first specifies the row of the break, the second specifies the
starting column, and the third specifies the ending column for the
break. All row and column numbers are 1-based, and the breaks occur
after the row or column. This array is sorted by row, and then by
starting/ending column. No two page breaks may overlap.
CALCCOUNT: Iteration Count (0Ch)
The CALCCOUNT record stores the Maximum Iterations option from the
Options dialog box, Calculation tab.
Iteration count
CALCMODE: Calculation Mode (0Dh)
The CALCMODE record stores options from the Options dialog box,
Calculation tab.
Calculation mode:
= 0 for manual
= 1 for automatic
= –1 for automatic, except tables
CODEPAGE: Default Code Page (42h)
The CODEPAGE record stores the default code page (character set) that
was in use when the workbook was saved.
Code page the file is saved in.
COLINFO: Column Formatting Information (7Dh)
The COLINFO record describes the column formatting for a range of
columns.
First formatted column (0-based)
Last formatted column (0-based)
Column width, in 1/256s of a character width
Index to XF record that contains the default format for the column
(for more information about the XF records, see "XF" on page 426)
Options
Reserved; must be 0 (zero)
The width of the column in characters of the default font
CONTINUE: Continues Long Records (3Ch)
Records that are longer than 8228 bytes (2084 bytes in BIFF7 and
earlier) must be split into several records. The first section appears
in the base record; subsequent sections appear in CONTINUE records.
In BIFF8, the TXO record is always followed by CONTINUE records that
store the string data and formatting runs.
Continuation of record data
COUNTRY: Default Country and WIN.INI Country (8Ch)
This record contains localization information.
Default country index.
The default country index, iCountryDef, is determined by the
localized version of Microsoft Excel that created the BIFF file.
For example, all BIFF files created by the U.S. version of
Microsoft Excel have iCountryDef = 1.
Country index from the Win.ini file.
If Microsoft Excel for Windows created the BIFF file,
iCountryWinIni is equal to the index that corresponds to the
country setting in the Win.ini file.
DBCELL: Stream Offsets (D7h)
The DBCELL record stores stream offsets for the BIFF file. There is one
DBCELL record for each block of ROW records and associated cell records.
Each block can contain data for up to 32 rows. For more information
about the DBCELL record, see "Finding Cell Records in BIFF Files" on
page 440.
Offset from the start of the DBCELL record to the start of the
first ROW record in the block; this is an offset to an earlier
position in the stream.
Array of stream offsets (2 bytes each). For more information, see
"Finding Cell Records in BIFF Files" on page 440.
DEFAULTROWHEIGHT: Default Row Height (225h)
The DEFAULTROWHEIGHT record specifies the height of all undefined rows
on the sheet. The miyRw field contains the row height in units of
1/20th of a point. This record does not affect the row height of any
rows that are explicitly defined.
Option flags (see the following table)
Default row height
DEFCOLWIDTH: Default Width for Columns (55h)
The DEFCOLWIDTH record specifies the width, measured in characters, for
columns not explicitly sized in the COLWIDTH record.
Default width of the columns.
Excel adds some extra space to the default width, depending on the
default font and default font size. The algorithm how to exactly
calculate the resulting column width is not known.
Example: The default width of 8 set in this record results in a
column width of 8.43 using Arial font with a size of 10 points.
DELTA: Iteration Increment (10h)
The DELTA record stores the Maximum Change value from the Options
dialog box, Calculation tab. The number is in 8-byte IEEE
floating-point format.
Maximum iteration change.
DIMENSIONS: Cell Table Size (200h)
The DIMENSIONS record contains the minimum and maximum bounds of the
sheet. It provides a concise indication of the sheet size.
Note that both the rwMac and colMac fields are greater by 1 than the
actual last row and column. For example, a worksheet that exists
between cells B3 and D6 would have the following dimensions in the
dimensions record (note rows and columns are 0-based in BIFF files in
which row 1 and column A are both coded as 0):
First defined row on the sheet
Last defined row on the sheet, plus 1
Last defined column on the sheet, plus 1
First defined column on the sheet
Reserved; must be 0 (zero)
DSF: Double Stream File (161h)
The DSF record stores a flag that indicates if the workbook is a double
stream file. Double Stream files contain both BIFF8 and BIFF7 workbooks.
1 if the workbook is a double stream file, 0 otherwise.
EOF: End of File (0Ah)
The EOF record marks the end of the workbook stream or the end of one of
the substreams in the workbook stream. It has no record data field and
is simply 0A000000h.
EXTERNSHEET: External Reference (17h)
The EXTERNSHEET record specifies externally referenced workbooks.
In BIFF7 and earlier, multiple EXTERNSHEET records form a table in the
file. The cxals field of the EXTERNCOUNT record specifies the number of
EXTERNSHEET records. You should not change the order of EXTERNSHEET
records. In BIFF8, the SUPBOOK record stores the encoded pathname and
file name. There is one SUPBOOK record for each externally referenced
workbook. The EXTERNSHEET record contains a table (rgXTI) that points
to the SUPBOOK records. Several ptgs in a BIFF8 formula contain an ixti
field; this is the 0-based index to the rgXTI table in the EXTERNSHEET
record. An externally referenced workbook is called a source workbook.
The workbook that refers to it is called a dependent workbook.
Array of XTI structures.
XTI
EXTSST: Extended Shared String Table (FFh)
The EXTSST record contains a hash table that optimizes external copy
operations.
Number of strings in each bucket
Array of ISSTINF structures
FONT: Font Description (31h)
The workbook font table contains at least five FONT records. FONT
records are numbered as follows: ifnt = 00h (the first FONT record in
the table), ifnt = 01h, ifnt = 02h, ifnt = 03h, ifnt = 05h (minimum
table), and then ifnt = 06h, ifnt = 07h, and so on. Notice that
ifnt = 04h never appears in a BIFF file. This is for
backward-compatibility with previous versions of Microsoft Excel. If
you read FONT records, remember to index the table correctly, skipping
ifnt = 04h.
Height of the font (in units of 1/20th of a point).
Font attributes.
Index to the color palette. In other words Color.
Bold style; a number from 100dec to 1000dec (64h to 3E8h) that
indicates the character weight ("boldness"). The default values are
190h for normal text and 2BCh for bold text.
Superscript/subscript:
00h = None
01h = Superscript
02h = Subscript
Underline style:
00h = None
01h = Single
02h = Double
21h = Single Accounting
22h = Double Accounting
Font family, as defined by the Windows API LOGFONT structure.
Character set, as defined by the Windows API LOGFONT structure.
Reserved. :)
Length of the font name.
Unicode Flag
0 = Compressed
1 = Uncompressed
Font name.
LOGFONT
FORMAT: Number Format (41Eh)
The FORMAT record describes a number format in the workbook.
All the FORMAT records should appear together in a BIFF file. The order
of FORMAT records in an existing BIFF file should not be changed. You
can write custom number formats in a file, but they should be added at
the end of the existing FORMAT records.
Format index code (for public use only).
Microsoft Excel uses the ifmt field to identify built-in formats
when it reads a file that was created by a different localized
version. For more information about built-in formats, see "XF" on
page 426.
Length of the format string.
Format string attributes.
1 = Uncompressed Unicode
Number format string.
Number of built-in function groups.
GRIDSET: State Change of Gridlines Option (82h)
This record indicates that the user changed the state of the Gridlines
option in the Page Setup dialog box, Sheet tab.
= 1 if the user has ever changed the setting of the Gridlines option
GUTS: Size of Row and Column Gutters (80h)
This record contains the size of the row and column gutters, measured
in screen units. The row and column gutters are the spaces that contain
outline symbols. They are located above column headings and to the left
of row headings.
Size of the row gutter that appears to the left of the rows
Size of the column gutter that appears above the columns
Maximum outline level (for the row gutter)
Maximum outline level (for the column gutter)
HCENTER: Center Between Horizontal Margins (83h)
If the Horizontally option is selected on the Margins tab in the Page
Setup dialog box, fHCenter = 1.
= 1 if the sheet is to be centered between horizontal margins when
printed
HIDEOBJ: Object Display Options (8Dh)
The HIDEOBJ record stores options selected in the Options dialog box,
View tab.
= 2 if the Hide All option is turned on
= 1 if the Show Placeholders option is turned on
= 0 if the Show All option is turned on
HORIZONTALPAGEBREAKS: Explicit Row Page Breaks (1Bh)
The HORIZONTALPAGEBREAKS record contains a list of explicit row page
breaks. The cbrk field contains the number of page breaks. Each element
of the rgbrk structure contains three 2-byte integers: the first
specifies the row of the break, the second specifies the starting
column, and the third specifies the ending column for the break. All
row and column numbers are 1-based, and the breaks occur after the row
or column. This array is sorted by row, and then by starting/ending
column. No two page breaks may overlap.
Number of page breaks.
Array of brk structures.
INDEX: Index Record (20Bh)
Microsoft Excel writes an INDEX record immediately after the BOF record
for each worksheet substream in a BIFF file. For more information about
the INDEX record, see "Finding Cell Records in BIFF Files" on page 440.
Reserved; must be 0 (zero)
First row that exists on the sheet
Last row that exists on the sheet, plus 1
Reserved; must be 0 (zero)
Array of file offsets to the DBCELL records for each block of ROW
records. A block contains ROW records for up to 32 rows. For more
information, see "Finding Cell Records in BIFF Files" on page 440.
The stream position where the strings begin (stream pointer into
the SST record)
Offset into the SST record that points to where the bucket begins
Reserved; must be 0 (zero)
INTERFACEHDR: Beginning of User Interface Records (E1h)
This record marks the beginning of the user interface section of
the Book (Workbook) stream. In BIFF7 and earlier, it has no record
data field. In BIFF8 and later, the INTERFACEHDR record data field
contains a 2-byte word that is the code page. This is exactly the
same as the cv field of the the CODEPAGE record.
Code page the file is saved in
ITERATION: Iteration Mode (11h)
The ITERATION record stores the Iteration option from the Options
dialog box, Calculation tab.
= 1 if the Iteration option is on
LABEL: Cell Value, String Constant (204h)
A LABEL record describes a cell that contains a string constant. The rw
field contains the 0-based row number. The col field contains the
0-based column number. The string length is contained in the cch field
and must be in the range of 0000h–00FFh (0–255). The string itself is
contained in the rgch field.
Row
Column
Index to the XF record
Length of the string
The string
LABELSST: Cell Value, String Constant/SST (FDh)
A LABELSST record describes a cell that contains a string constant from the shared string table, which is new to BIFF8. The rw field contains the 0-based row number. The col field contains the 0-based column number. The string itself is contained in an SST (shared string table) record, and the isst field is a 0-based index into the shared string table.
Row
Column
Index into the SST record
Index to the XF record
In inches.
This record contains the addresses of merged cell ranges in the current
sheet. If the record size exceeds the limit, it is not continued with a
CONTINUE record, but another self-contained MERGEDCELLS record is
started.
The limit of 8224 bytes per record results in a maximum number of 1027
merged ranges.
Example: A sheet contains 1040 merged cell ranges. The first MERGEDCELLS
record contains a list of 1027 range addresses (the leading number of
ranges is 1027 too). Following a second MERGEDCELLS record with the
remaining 13 merged ranges.
Number of merged ranges
Cell range address list with merged ranges
MMS: ADDMENU/DELMENU Record Group Count (C1h)
This record stores the number of ADDMENU groups and DELMENU groups in
the Book stream.
Number of ADDMENU record groups.
Number of DELMENU record groups.
MSODRAWING: Microsoft Office Drawing (ECh)
This record contains a drawing object provided by the Microsoft Office
Drawing tool. For more information on this file format, see the article "Microsoft Office Drawing File Format" on the Microsoft Developer Network Online Web site (http://www.microsoft.com/msdn/).
MULBLANK: Multiple Blank Cells (BEh)
The MULBLANK record stores up to the equivalent of 256 BLANK records;
the MULBLANK record is a file size optimization. The number of ixfe
fields can be determined from the ColLast field and is equal to
(colLast - colFirst + 1). The maximum length of the MULBLANK record is
(256 x 2 + 10) = 522 bytes, because Microsoft Excel has at most 256
columns. Note that storing 256 blank cells in the MULBLANK record takes
522 bytes as compared with 2560 bytes for 256 BLANK records.
Column number (0-based) of the first column of the multiple RK
record
Last column containing the BLANKREC structure
Row number (0-based)
NAME: Defined Name (18h)
The NAME record describes a defined name in the workbook.
The NAME record stores two types of names: global names and local names.
A global name is defined for an entire workbook, and a local name is
defined on a single sheet. For example, MyName is a global name, whereas
Sheet1!MyName is a local name.
Option flags
Keyboard shortcut
Length of the name text
Length of the name definition
Index to the sheet that contains this name, if the name is a local
name. The ixals field in the NAME record will be nonzero for local
names and will index the list of EXTERNSHEET records for the sheets
in the workbook. The following field, itab, is equal to ixals.
This field is equal to ixals.
Length of the custom menu text
Length of the description text
Length of the help topic text
Length of the status bar text
Unicode Flag
0 = Compressed
1 = Uncompressed
Name text
Name definition
1904: 1904 Date System (22h)
The 1904 record stores the date system used by Microsoft Excel.
= 1 if the 1904 date system is used
NUMBER: Cell Value, Floating-Point Number (203h)
A NUMBER record describes a cell containing a constant floating-point
number. The rw field contains the 0-based row number. The col field
contains the 0-based column number. The number is contained in the num
field in 8-byte IEEE floating-point format.
Row
Column
Index to the XF record
Floating-point number value
OBJ: Describes a Graphic Object (5Dh)
BIFF files may contain several different variations of the OBJ record.
They correspond to the graphic objects and dialog box controls available
in Microsoft Excel: line object, rectangle object, check box object,
and so on.
PANE: Number of Panes and Their Position (41h)
The PANE record describes the number and position of unfrozen panes in
a window.
Vertical position of the split; 0 (zero) if none
Horizontal position of the split; 0 (zero) if none
Top row visible in the bottom pane
Leftmost column visible in the right pane
Pane number of the active pane
PASSWORD: Protection Password (13h)
The PASSWORD record contains the encrypted password for a protected
sheet or workbook. Note that this record specifies a sheet-level or
workbook-level protection password, as opposed to the FILEPASS record,
which specifies a file password.
Encrypted password.
PRECISION: Precision (0Eh)
The PRECISION record stores the Precision As Displayed option from the
Options dialog box, Calculation tab.
s
= 0 if Precision As Displayed option is selected
PRINTGRIDLINES: Print Gridlines Flag (2Bh)
This record stores the Gridlines option from the Page Setup dialog box,
Sheet tab.
= 1 to print gridlines
PRINTHEADERS: Print Row/Column Labels (2Ah)
The PRINT HEADERS record stores the Row And Column Headings option from
the Page Setup dialog box, Sheet tab.
= 1 to print row and column headings
PROT4REV: Shared Workbook Protection Flag (1AFh)
The PROT4REV record stores a shared-workbook protection flag.
= 1 if the Sharing with Track Changes option is on (Protect Shared
Workbook dialog box)
PROT4REVPASS: Shared Workbook Protection Password (1BCh)
The PROT4REV record stores an encrypted password for shared-workbook
protection.
Encrypted password (if this field is 0 (zero), there is no Shared
Workbook Protection Password; the password is entered in the
Protect Shared Workbook dialog box)
PROTECT: Protection Flag (12h)
The PROTECT record stores the protection state for a sheet or workbook.
= 1 if the sheet or workbook is protected
Range
Gets a column width or row height in pixels.
Horizontal for column width, Vertical for row
height.
The zero based index of the col/row
The dimension of the col/row in pixels.
Direction
This record contains an ID that marks when a worksheet was last
recalculated. It's an optimization Excel uses to determine if it
needs to recalculate the spreadsheet when it's opened. So far, only
the two values 0xC1 0x01 0x00 0x00 0x80 0x38 0x01 0x00
(do not recalculate) and 0xC1 0x01 0x00 0x00 0x60 0x69 0x01 0x00
have been seen. If the field isNeeded is set to false (default), then
this record is swallowed during the serialization process
rt
reserved
dwBuild
REFMODE: Reference Mode (0Fh)
The REFMODE record stores the Reference Style option from the Options dialog box, General tab.
Reference mode:
= 1 for A1 mode
= 0 for R1C1 mode
REFRESHALL: Refresh Flag (1B7h)
This record stores an option flag.
= 1 then Refresh All should be done on all external data ranges and
PivotTables when loading the workbook (the default is = 0)
The height of the row in points
Determines whether the row should be autosized by Excel.
ROW: Describes a Row (208h)
A ROW record describes a single row on a Microsoft Excel sheet. ROW
records and their associated cell records occur in blocks of up to
32 rows. Each block ends with a DBCELL record. For more information
about row blocks and about optimizing your code when searching for cell
records, see "Finding Cell Records in BIFF Files" on page 440.
Row number.
First defined column in the row.
Last defined column in the row, plus 1.
The miyRw field contains the row height, in units of 1/20th of a
point.
Used by Microsoft Excel to optimize loading the file; if you are
creating a BIFF file, set irwMac to 0.
Reserved
Option flags.
If fGhostDirty = 1 (see grbit field), this is the index to the XF
record for the row. Otherwise, this field is undefined.
Sets the row height in points
SAVERECALC: Recalculate Before Save (5Fh)
If the Recalculate Before Save option is selected in the Options dialog
box, Calculation tab, then fSaveRecalc = 1.
= 1 to recalculate before saving
SELECTION: Current Selection (1Dh)
The SELECTION record stores the selection.s
Number of the pane described
Row number of the active cell
Column number of the active cell
Ref number of the active cell
Number of refs in the selection
Array of refs
SETUP: Page Setup (A1h)
The SETUP record stores options and measurements from the Page Setup
dialog box.
Paper size (see fNoPls in the following table)
Scaling factor (see fNoPls in the following table)
Starting page number
Fit to width; number of pages
Fit to height; number of pages
Option flags (see the following table)
Print resolution (see fNoPls in the following table)
Vertical print resolution (see fNoPls in the following table)
Header margin (IEEE number)
Footer margin (IEEE number)
Number of copies (see fNoPls in the following table)
SST: Shared String Table (FCh)
The SST record contains string constants.
Total number of strings in the shared string table and extended
string table (EXTSST record)
Number of unique strings in the shared string table.
Array of unique strings.
The rgb field contains an array of unicode strings.
SSTHelper
STYLE: Style Information (293h)
Each style in a Microsoft Excel workbook, whether built-in or
user-defined, requires a style record in the BIFF file. When Microsoft
Excel saves the workbook, it writes the STYLE records in alphabetical
order, which is the order in which the styles appear in the drop-down
list box.
Index to the style XF record.
Built-in style numbers:
= 00h Normal
= 01h RowLevel_n
= 02h ColLevel_n
= 03h Comma
= 04h Currency
= 05h Percent
= 06h Comma[0]
= 07h Currency[0]
Level of the outline style RowLevel_n or ColLevel_n.
SUPBOOK: Supporting Workbook (1AEh)
This record stores data about a supporting external workbook.
Number of tabs in the workbook.
WTF?
TABID: Sheet Tab Index Array (13Dh)
This record contains an array of sheet tab index numbers. The record is
used by the Shared Lists feature. The sheet tab indexes have type short
int (2 bytes each). The index numbers are 0-based and are assigned when
a sheet is created; the sheets retain their index numbers throughout
their lifetime in a workbook. If you rearrange the sheets in a workbook,
the rgiTab array will change to reflect the new sheet arrangement. This
record does not appear in BIFF5 files.
Array of tab indexes.
USESELFS: Natural Language Formulas Flag (160h)
This record stores a flag bit.
= 1 if this file was written by a version of Microsoft Excel that
can use natural-language formula input
VCENTER: Center Between Vertical Margins (84h)
If the Center On Page Vertically option is on in the Page Setup dialog
box, Margins tab, then fVCenter = 1.
= 1 if the sheet is to be centered between the vertical margins
when printed
WINDOW1: Window Information (3Dh)
The WINDOW1 record contains workbook-level window attributes. The xWn
and yWn fields contain the location of the window in units of 1/20th of
a point, relative to the upper-left corner of the Microsoft Excel
window client area. The dxWn and dyWn fields contain the window size,
also in units of 1/20th of a point.
Horizontal position of the window.
Vertical position of the window.
Width of the window.
Height of the window.
Option flags:
Bit 0: = 1 if the window is hidden
Bit 1: = 1 if the window is currently displayed as an icon
Bit 2: Reserved
Bit 3: = 1 if the horizontal scroll bar is displayed
Bit 4: = 1 if the vertical scroll bar is displayed
Bit 5: = 1 if the workbook tabs are displayed
Bit 6: Reserved
Bit 7: Reserved
Index of the selected workbook tab (0-based).
Index of the first displayed workbook tab (0-based).
Number of workbook tabs that are selected.
Ratio of the width of the workbook tabs to the width of the
horizontal scroll bar; to obtain the ratio, convert to decimal and
then divide by 1000.
WINDOW2: Sheet Window Information (23Eh)
The WINDOW2 record contains window attributes for a sheet in a workbook.
Option flags
Top row visible in the window
Leftmost column visible in the window
Index to color value for row/column headings and gridlines
Zoom magnification in page break preview
Zoom magnification in normal view
Reserved
WINDOWPROTECT: Windows Are Protected (19h)
The WINDOWPROTECT record stores an option from the Protect Workbook
dialog box.
= 1 if the workbook windows are protected.
WRITEACCESS: Write Access User Name (5Ch)
This record contains the user name, which is the name you type when
you install Microsoft Excel.
For more info on how to write Unicode string in Excel, see 2.3.
Length of the Unicode string.
Option flags
1 = Uncompressed (16-bit characters)
User name
WSBOOL: Additional Workspace Information (81h)
This record stores information about workspace settings.
Option flags
XF: Extended Format (E0h)
The XF record stores formatting properties. There are two different XF
records, one for cell records and another for style records. The fStyle
bit is true if the XF is a style XF. The ixfe of a cell record
(BLANK, LABEL, NUMBER, RK, and so on) points to a cell XF record, and
the ixfe of a STYLE record points to a style XF record. Note that in
previous BIFF versions, the record number for the XF record was 43h.
Prior to BIFF5, all number format information was included in FORMAT
records in the BIFF file. Beginning with BIFF5, many of the built-in
number formats were moved to an public table and are no longer saved
with the file as FORMAT records. You still use the ifmt to associate
the built-in number formats with an XF record. However, the public
number formats are no longer visible in the BIFF file.
Index to the FONT record.
Index to the FORMAT record.
Bits about hiding, locking and others.
Alignment, Wrap, Rotation bits.
Shrink to fit and merger bits.
Border Line Style
Bits about indices to color pallete of borders.
Bits about indices to color pallete of borders.
Index to the color pallete for the fill.
This is a 0-byte record, so it only needs to exist in order to tell
Excel 2000 that the file has been written to by Excel 2000.
Represents a StreamWriter for writing RTF documents.
Creates a new instance of the RtfWriter in Compact writing mode
with the given stream.
The stream to write to.
Creates a new instance of the RtfWriter with the given RtfWriterMode
and the given stream.
The stream to write to.
The writer mode.
Starts a new RTF group.
The entity that starts the group.
Ends the owner's group and all groups inside it.
The entity that ends the group.
Writes an attribute.
The Attribute to write.
Writes info for older readers that do not understand nested tables.
Gets the writer mode.
Gets the Group that is on top of the group stack.
Gets the current group level (zero-based). Return -1 if the group
stack is empty.
The RtfWriter mode specifies how an RtfWriter should output content.
The RTF stream contains no unnecessary characters. This is default
in release build.
The RTF stream is structured so that it is human-readable. This is
default in debug build.
Represents an RTF control word. A control word is a specially formatted
command that RTF uses to mark printer control codes and information that
applications use to manage documents. A control word cannot be longer
than 32 characters.
Represents the base class for all RTF nodes.
When overriden in a derived class this methods should perform all
preparation before the Node is written, i.e. set Attribute values,
prepare child nodes, etc.
When overridden in a derived class, saves the current node to the
specified RtfWriter.
The RtfWriter to which you want to save.
Sets the document of the node.
The document of the node.
Checks whether there is a circular reference between two nodes.
If the toFind node is encountered anywhere going up from the bottom
node an ArgumentException is thrown.
The node from which to start climbing up the
parent-child hierarchy.
The control to look for.
Gets the child nodes of this node.
Represents the collection of nodes belonging to a node.
Validate the name of the attribute.
Validate the value of the attribute.
Validates the length of the attribute.
Gets or sets the name of the attribute.
Gets or sets an optional value for the attribute.
Gets the attributes of this node.
Width adjusted for MS Word behavior. For example when you set a
double border and specify a width of 1pt, Word makes it 3pt --
1pt for each line and 1pt for the space between etc. Use this for
writing the actual value to the writer.
Represents a table cell. The table cell is just a weird kind of
paragraph with some additional attributes that need to be written
in the row's definition.
Represents a RTF Group. Groups are enclosed in braces.
Adds a TextRun with the specified text to the paragraph. If
copyStyle is true then the text run is initialized
with the paragraph properties, such as Font, Color, BackgroundColor.
The text for the TextRun.
Indicates whether to initialize
the new text run with the paragraph style properties.
The TextRun that was added.
Adds a TextRun with the specified text to the paragraph. If
copyStyleFromParagraph is true then the text run is initialized
with the paragraph properties. Otherwise, it is left default.
The text for the TextRun.
The font name for the TextRun.
The font size in points for the TextRun.
The font style for the TextRun.
The text color for the TextRun.
The background color of the TextRun.
The TextRun that was added.
The font size in points.
Needed because of the "Picture Cell with BottomPadding" MS Word bug.
Cell defintion. The thing written as part of the row before cells'
content begins.
The first cell in a range of table cells to be merged.
Contents of the table cell are merged with those of the
preceding cell.
The first cell in a range of table cells to be vertically
merged.
Contents of the table cell are vertically merged with those of
the preceding cell.
This method adds merging information to the cell depending on
several factors. Here is a simple example of a 3x3 merged range:
With RTF control words:
|------|------|------|
|clmgf |clmrg |clmrg |
|clvmgf|clvmgf|clvmgf|
|------|------|------|
|clmgf |clmrg |clmrg |
|clvmrg|clvmrg|clvmrg|
|------|----- |------|
|clmgf |clmrg |clmrg |
|clvmrg|clvmrg|clvmrg|
|------|----- |------|
Legend: HM = Horizontal Master
VM = Vertical Master
HS = Horizontal Slave
VS = Vertical Slave
|------|------|------|
|HM |HS |HS |
|VM |VM |VM |
|------|------|------|
|HM |HS |HS |
|VS |VS |VS |
|------|----- |------|
|HM |HS |HS |
|VS |VS |VS |
|------|----- |------|
Indicates whether the cell is in the top row of the merged range.
Indicates whether the cell is in the bottom row of the merged range.
Indicates whether the cell is in the leftmost column of the
merged range.
Indicates whether the cell is in the rightmost column of the
merged range.
Returns true if the cell takes part in a horizontally merged
range.
Returns true if the cell takes part in a horizontally merged
range.
Returns true if the cell is the merge target, i.e. the top left
cell in the range.
Returns true if the cell is in the same column as the merge
target.
Returns true if the cell is in the same row as the merge target.
Return true is the cell is right of its merge target.
Returns true if the cell is below its merge target.
A border used for table cells. The only difference is the
StartElement which begins with "cl".
Utility class for conversions.
Converts mm to twips.
1in = 72pt = 1440twips
1in = 2.54cm = 25.4mm
1mm = 1440/25.4
The amount in points.
The amount in twips.
Certain control words, referred to as destinations, mark the beginning
of a collection of related text that could appear at another position,
or destination, within the document. Destinations may also be text that
is used (but should not appear) within the document at all. Destinations
added after the RTF Specification published in the March 1987 Microsoft
Systems Journal may be preceded by the control symbol \* (backslash
asterisk). This control symbol identifies destinations whose related
text should be ignored if the RTF reader does not recognize the
destination control word. (RTF writers should follow the convention of
using this control symbol when adding new destinations or groups.)
Destinations whose related text should be inserted into the document
even if the RTF reader does not recognize the destination should not use
\*. All destinations that were not included in the March 1987 revision
of the RTF Specification are shown with \* as part of the control word.
An attribute without value.
DeviceCapsParams
Represents a RTF document. An entire RTF file is considered
a group and must be enclosed in braces.
http://msdn2.microsoft.com/en-us/library/aa140298(office.10).aspx
Adjusts the bounds of the frame taking into account how MS Word
renders frames with borders.
Gets or sets the location of the frame in millimeters.
Gets or sets the size of the frame in millimeters.
Represents and RTF document header.
http://msdn2.microsoft.com/en-us/library/aa140301(office.10).aspx
Specifies the vertical alignment of an object or text in a report item.
Specifies that the object is aligned to the left.
Specifies that the object is aligned to the center.
Specifies that the object is aligned to the right.
Specifies that the object is justified.
Creates a Graphics for drawing in the specified image with the
given unit of measure.
The image to draw to.
The unit of measure for the Graphics.
A Graphics object that will draw in the supplied image.
Returns a GDICompatible metafile size.
The desired size in millimeters.
A RectangleF representing a metafile bounds in 100ths of an millimeter.
Represents a document page. (RTF section)
Calculates (in mm) where the origin of the image should be so that
it is centered with respect to the container.
The size of the container.
The size of the image.
The sizing mode of the picture.
The repeat mode of the background picture.
Represents a table row
Yet another MS Word issue is alleviated by this method.
When there is an image in the row there should not be any
bottom padding because word stretches everything a lot.
Writes the header of a row. Used by a table after its end or by
the nested table properties at the end of a row.
Writes the nested table properties at the end of a row is nested.
Writes the cell definitions only -- without the actual cell
contents. Used by a nested table to "repeat" its parent row
definitions at the end of the table.
Writes the cell content.
CellCollection
Represents a RTF Table.
Removes the ghost columns/rows served by the crosstab.
Nested tables are the weirdest shit of all. PURE BRAINFUCK.
Repeat the contents of the parent row after this table is
finished in order for the older readers to understand the
table. See the specification example for more info. Also
check out Apache FOP (http://xmlgraphics.apache.org/fop/) to
see their implementation as a reference.
Returns the row that contains the cell that contains this table.
Represents the text flow of a table cell.
Text in a cell flows from left to right and top to bottom
(default).
Text in a cell flows right to left and top to bottom.
Text in a cell flows left to right and bottom to top. Represents
rotation by -90 degrees.
Text in a cell flows left to right and top to bottom,
vertical.
Text in a cell flows top to bottom and right to left
, vertical. Represents rotation by 90 degrees.
Represents a text run in a paragraph.
The font size in points.
Leaf
RenderingElement
Implements the common rendering logic for all rtf rendering items.
Calculates the minimal distance from the above and left standing
items.
Adjusts the item position so that the minimal
distance from the items above and to the left is preserved.
Adjusts the item position so that the minimal
distance from the items above is preserved.
Adjusts the item position so that the minimal
distance from the items to the left is preserved.
RenderingElementContainer
For each child element, determines in which cell it will fall and
links it to that cell. If the element spans several rows/columns the
target cell is merged.
Checks whether two rectangles intersect with each other
using the specified measurement unit and precision.
Compares items to arrange them in Left-Right Top-Bottom order.
Group
RenderingElementProxy
LayoutEngine
LayoutInfo
PictureBox
RenderingElementCollection
These are the REAL Word PageHeader and PageFooter so I can render
them only if I am not part of a ReportBook. If I am part of a report
book and each report in the book has different PageHeader/PageFooter
then which one should it be. The simple answer is no one.
See the summary of RenderPageSections for more info.
Very neat. Replace the PageNumber and PageCount with Word's special
control words and let Word do the rest.
RtfTableReport -- hidden, used by the dispatcher.
RTF Hack -- it renders borders insanely and we have to recalculate.
Otherwise the table/crosstab's right/bottom borders are cannot fit
into the container and are clipped/invisible.
RTF Hack -- it renders borders insanely and we have to recalculate.
Otherwise the table/crosstab's right/bottom borders cannot fit
into the container and are clipped/invisible.
RtfTextBox
True if additional frame is created
The needed margin in Mm
Proper font size in points
RtfFrameReport -- hidden, used by the dispatcher.
The dispatcher RTF rendering extension.
Creates the string format used for drawing.
The original string format of the report item.
Draws rotated text lines in an image.
The original string format of the report item.
In degrees.
Creates the string format used for drawing.
The original string format of the report item.
Draws rotated text lines in an image.
The original string format of the report item.
In degrees.
Writes image as resource and returns the url.
Stores a reference to the image, so that the already stored bytes
can be reused if used second time.
This method is not applicable for instantly created images!
Writes image as resource and returns the url.
Applicable for instantly created images.
Writes image contained in the container as resource and returns the url.
Stores the image key (see IImageContainer), so that the already stored bytes
can be reused if used second time.
Creates the user defined encoding and creates Unicode instances with BOM set if needed
BOM References: http://www.sttmedia.com/unicode-byteordermark http://www.unicode.org/faq/utf_bom.html#bom8
Represents a flat table renderer API implementer
Crosstab / Table CSV renderer
Encapsulates the algorithm of turning the Processing Crosstab/Table into a flat table
Gets the element at the provided cell coordinates
Serializes and deserializes objects into and from XML.
This class is dedicated for serializing and deserializing objects
only from the namespace.
The following example demonstrates how to create a report definition, how to serialize and deserialize it in XML and the corresponding XML output.
Creating the report definition: