Back to Devexpress

PrintableComponentContainer Members

xtrareports-devexpress-dot-xtrareports-dot-ui-dot-printablecomponentcontainer-dot-underscore-members.md

latest34.9 KB
Original Source

PrintableComponentContainer Members

A container that is used to add DevExpress controls, Windows Forms controls, controls that implement the IPrintable interface, and documents created using printing links to a report.

Constructors

NameDescription
PrintableComponentContainer()Initializes a new instance of the PrintableComponentContainer class with the default settings.

Properties

NameDescription
AnchorHorizontalSpecifies the horizontal anchoring type of a report control. Inherited from XRControl.
AnchorVerticalSpecifies the vertical anchoring style of a report control. Inherited from XRControl.
BackColorOverrides the XRControl.BackColor property.
BandProvides access to the owner band, in which the current control is situated. Inherited from XRControl.
BookmarkBindable. Gets or sets the text of a bookmark for this control. Inherited from XRControl.
BookmarkParentGets or sets the report control whose bookmark is the parent of the current bookmark. Inherited from XRControl.
BorderColorOverrides the XRControl.BorderColor property.
BorderDashStyleOverrides the XRControl.BorderDashStyle property.
BordersOverrides the XRControl.Borders property.
BorderWidthOverrides the XRControl.BorderWidth property.
BottomFGets the Y-coordinate of the control’s bottom edge (measured in report units). Inherited from XRControl.
BoundsFSpecifies the location and size of a report element, according to the system of measurement selected for the report. Inherited from XRControl.
CanGrowGets or sets a value indicating whether the control’s height can grow in order to display the content in its entirety. Inherited from XRControl.
CanHaveChildrenGets a value indicating whether the control can contain other controls. Inherited from XRControl.
CanPublishOptionsSpecifies report control visibility on printouts and in documents exported to specific formats. Inherited from XRControl.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CanShrinkGets or sets a value that determines whether the height of a control can decrease if its content does not completely fill the control. Inherited from XRControl.
ClipContentSpecifies whether to clip the content which does not within the PrintableComponentContainer‘s bounds, or increase the control’s dimensions to display the content in full.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ControlsGets the collection of XRControl objects or their descendants that are contained in this control. Inherited from XRControl.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExpressionBindingsProvides access to a control’s collection of expression bindings. Inherited from XRControl.
FormattingRulesProvides access to a collection of formatting rules applied to this control. Inherited from XRControl.
HasChildrenGets a value indicating whether the control contains other XRControl objects. Inherited from XRControl.
HeightFSpecifies the control’s height (measured in report units). Inherited from XRControl.
IndexGets the zero-based index of this control in its parent’s collection of controls. Inherited from XRControl.
IsDisposedFor internal use. Gets a value indicating whether the control has been disposed of. Inherited from XRControl.
IsSingleChildChecks whether the report element (control or band) is a single child of its parent. Inherited from XRControl.
KeepTogetherSpecifies whether a control can be split across pages. Inherited from XRControl.
LeftFSpecifies the X-coordinate of the control’s left edge (measured in report units). Inherited from XRControl.
LocationFSpecifies the floating-point representation of the coordinates of the control’s upper-left corner. Inherited from XRControl.
LocationFloatFor internal use. Supports serialization of the XRControl.LocationF property. Inherited from XRControl.
LockedInUserDesignerGets or sets a value that specifies whether this control can be changed by an end-user in the End-User Designer. Inherited from XRControl.
NameGets or sets a name of the control. Inherited from XRControl.
NavigateUrlBindable. Specifies the URL to navigate to when a control is clicked. Inherited from XRControl.
PaddingSpecifies the inner spacing between the borders of the PrintableComponentContainer and the content it displays.
ParentSpecifies the parent object that contains the current control. Inherited from XRControl.
PrintableComponentSpecifies a control or a printing link inside the PrintableComponentContainer at runtime.
ReportProvides access to the report that contains the control. Inherited from XRControl.
RightFGets the X-coordinate of the control’s right edge (measured in report units). Inherited from XRControl.
RootReportProvides access to the report to which the control belongs. Inherited from XRControl.
ScriptsProvides access to an object that contains XRControl-specific scripts to handle its events in the End-User Report Designer. Inherited from XRControl.
SiteGets or sets the ISite of the Component. Inherited from Component.
SizeFGets or sets the size of the control. Inherited from XRControl.
SnapLineMarginSpecifies the control’s margins that are maintained when the control is aligned using snap lines. Inherited from XRControl.
StylePriorityAllows you to specify properties whose values for an individual control have priority over the same properties specified for the style assigned to the control. Inherited from XRControl.
TagBindable. Gets or sets the object that contains data about this control. Inherited from XRControl.
TargetSpecifies the target window or frame in which to display the linked Web page’s content, when the control is clicked. Inherited from XRControl.
TopFGets or sets the Y-coordinate of the control’s top edge (measured in report units). Inherited from XRControl.
VisibleGets or sets a value that specifies whether the report control is displayed in the document. Inherited from XRControl.
WidthFSpecifies the control’s width (measured in report units). Inherited from XRControl.
WindowControlOptionsSpecifies how to render a control inside the PrintableComponentContainer.

Methods

NameDescription
AllControls<T>()Returns a collection that contains all controls found within XRControl (within a report). Inherited from XRControl.
BringToFront()Brings the control to the front of the z-order. Inherited from XRControl.
CreateObjRef(Type)Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose()Releases all resources used by the Component. Inherited from Component.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
FindControl(String, Boolean)Finds the control that has the specified name in the XRControl.Controls collection. Inherited from XRControl.
GetEffectiveBackColor()Returns the color actually used as the control’s background color. Inherited from XRControl.
GetEffectiveBorderColor()Returns the color actually used as the control’s border color. Inherited from XRControl.
GetEffectiveBorderDashStyle()Returns the border dash style that is actually used by the control. Inherited from XRControl.
GetEffectiveBorders()Returns the borders settings actually used as the control’s borders settings. Inherited from XRControl.
GetEffectiveBorderWidth()Returns the border width settings actually used as the control’s current settings. Inherited from XRControl.
GetEffectiveFont()Returns the font actually used as the control’s font. Inherited from XRControl.
GetEffectiveForeColor()Returns the color actually used as the control’s foreground color. Inherited from XRControl.
GetEffectivePadding()Returns the padding values actually used as the control’s padding. Inherited from XRControl.
GetEffectiveStyle()Returns the actual visual style of a control taking into account all formatting rules and odd/even styles applied to the control. Inherited from XRControl.
GetEffectiveTextAlignment()Returns the text alignment actually used as the control’s text alignment. Inherited from XRControl.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetLifetimeService()Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type) protectedReturns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType()Gets the Type of the current instance. Inherited from Object.
InitializeLifetimeService()Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
PerformLayout()Forces the control to apply layout logic to itself and all its child controls. Inherited from XRControl.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
RemoveInvalidBindings(Predicate<XRBinding>)Removes inappropriate bindings assigned to the XRControl‘s properties. Inherited from XRControl.
ResetBackColor()Resets the XRControl.BackColor property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetBorderColor()Resets the XRControl.BorderColor property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetBorderDashStyle()Resets the XRControl.BorderDashStyle property to en empty value. Inherited from XRControl.
ResetBorders()Resets the XRControl.Borders property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetBorderWidth()Resets the XRControl.BorderWidth property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetFont()Resets the XRControl.Font property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetForeColor()Resets the XRControl.ForeColor property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetPadding()Resets the XRControl.Padding property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResetTextAlignment()Resets the XRControl.TextAlignment property value, so that it is no longer stored in the current control and is obtained from its parent instead. Inherited from XRControl.
ResumeLayout()Resumes normal layout logic for the control. Inherited from XRControl.
SendToBack()Sends the control to the back of the z-order. Inherited from XRControl.
SuspendLayout()Temporarily suspends the layout logic for the control. Inherited from XRControl.
ToImage()Returns a graphical representation of a control. Inherited from XRControl.
ToImage(DXTextRenderingHint)Returns the graphical representation of a control created using the specified text rendering mode. Inherited from XRControl.
ToString()Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

NameDescription
AfterPrintOccurs after an XRControl object is displayed in the report. Inherited from XRControl.
BeforePrintOccurs before an XRControl object creates its image in a report being generated. Inherited from XRControl.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DrawOccurs when an XRControl object is drawn or redrawn in a report’s Print Preview. Inherited from XRControl.
EvaluateBindingOccurs after a data-bound XRControl object obtains data from its data source. Inherited from XRControl.
HtmlItemCreatedOccurs when a new item used for a Web representation of the control is created. Inherited from XRControl.
LocationChangedOccurs when the value of the XRControl.LocationF property is changed. Inherited from XRControl.
ParentChangedOccurs when the XRControl instance’s parent is changed. Inherited from XRControl.
PreviewClickOccurs when the mouse button is clicked while the cursor is hovering over one of the bricks created by the XRControl for its representation in the report preview. Inherited from XRControl.
PreviewDoubleClickOccurs when the left mouse button is double-clicked while the cursor is hovering over one of the bricks created for the control‘s representation in the report preview. Inherited from XRControl.
PreviewMouseDownOccurs when an end-user presses the mouse button while the mouse pointer is hovering over one of the bricks created for the control‘s representation in the report preview. Inherited from XRControl.
PreviewMouseMoveOccurs when the mouse cursor moves over the control during the report’s preview. Inherited from XRControl.
PreviewMouseUpOccurs when an end-user releases the left mouse button while the mouse pointer is hovering over one of the bricks created for the control‘s representation in the report preview. Inherited from XRControl.
PrintableComponentChangedOccurs when a new control or document is placed inside the PrintableComponentContainer.
PrintOnPageOccurs when the representation of a control is printed on the current page of the report. Inherited from XRControl.
SizeChangedOccurs when the value of the XRControl.SizeF property is changed. Inherited from XRControl.
TextChangedOccurs when the value of the XRControl.Text property is changed. Inherited from XRControl.
WinControlChangedFor internal use. Occurs when a new Control object has been assigned to the PrintableComponentContainer.

See Also

PrintableComponentContainer Class

DevExpress.XtraReports.UI Namespace