CellViewerManager Class

In This Topic

The CellViewerManager class allows for any control to be used as a viewer to display the content of a cell as well as allows custom painting of a cell's background and foreground.

Syntax

Visual Basic
C#

'Declaration
 
<DesignTimeVisibleAttribute(False)>
<ToolboxItemAttribute(False)>
Public Class CellViewerManager

'Usage
 
Dim instance As CellViewerManager

[DesignTimeVisible(false)]
[ToolboxItem(false)]
public class CellViewerManager

Remarks

In addition to the default CellViewerManager's that are provided, custom CellViewerManager's can be created by deriving from the CellViewerManager class and implementing the required functionalities, or by handling the events that are raised by the CellViewerManager class.

When generating a report using the reporting capabilities of Xceed Grid for .NET, CellViewerManagers will only be reproduced in the report if the GetImage(Object) and/or GetText(Object) methods return the image or text that is to be displayed (GetImageCore and/or GetTextCore have been overridden). In the case where the GetImageCore and/or GetTextCore methods have not been overridden to return the desired image and/or text, the string representation of the underlying cell's content will be displayed in the report.

Inheritance Hierarchy

System.Object
   Xceed.Grid.Viewers.CellViewerManager
      Xceed.Grid.Viewers.CheckBoxViewer
      Xceed.Grid.Viewers.ImageViewer
      Xceed.Grid.Viewers.TextViewer

Public Constructors

	Name	Description
	CellViewerManager Constructor	Overloaded.

Top

Public Properties

	Name	Description
	Container	Gets the System.ComponentModel.IContainer associated with the System.ComponentModel.ISite when implemented by a class.
	Control	Gets a reference to the underlining control used to view a cell's content.
	ImageAlignment	Gets or sets the alignment of the image in the ImageArea.
	ImageArea	Gets or sets the area where the viewer's image is displayed.
	ImagePadding	Gets or sets the padding surrounding the viewer's image.
	ImageSize	Gets or sets the size of the viewer's image.
	ImageStyle	Gets or sets a value indicating the style with which the image is displayed.
	IsReportStyleDefined	Gets a boolean value indicating if one or more properties of the ReportStyle have been explicitly set.
	PreserveImageAspectRatio	Gets or sets a boolean value indicating if the image should preserve its aspect ratio.
	PropertyName	Gets a value representing the property used to set the control's value.
	ReportStyle	Gets the report style of the viewer.
	Site	Gets or sets the System.ComponentModel.ISite associated with the System.ComponentModel.IComponent.
	TextPadding	Gets or sets the padding surrounding the viewer's text.

Top

Protected Properties

	Name	Description
	DefaultImageAlignment	Gets the default value of the ImageAlignment property.
	DefaultImageArea	Gets the default value of the ImageArea property.
	DefaultImagePadding	Gets the default value of the ImagePadding property.
	DefaultImageSize	Gets the default value of the ImageSize property.
	DefaultImageStyle	Gets the default value of the ImageStyle property.
	DefaultPreserveImageAspectRatio	Gets the default value of the PreserveImageAspectRatio property.
	DefaultTextPadding	Gets the default value of the TextPadding property.
	DesignMode	Gets a value that indicates whether the System.ComponentModel.Component is currently in design mode.
	Events	Gets a list of the events to which the CellViewerManager is subscribed.
	Properties	Gets a collection of property names whose values have been explicitly set as well as the corresponding values.

Top

Public Methods

	Name	Description
	Dispose	Overloaded. Releases all resources.
	GetImage	Overloaded. Retrieves the image displayed by the viewer and raises the QueryImage event.
	GetText	Overloaded. Retrieves the text displayed by the viewer and raises the QueryText event.
	ResetImageAlignment	Resets the value of the ImageAlignment property to its default value, DefaultImageAlignment.
	ResetImageArea	Resets the value of the ImageArea property to its default value, DefaultImageArea.
	ResetImagePadding	Resets the value of the ImagePadding property to its default value, DefaultImagePadding.
	ResetImageSize	Resets the value of the ImageSize property to its default value, DefaultImageSize.
	ResetImageStyle	Resets the value of the ImageStyle property to its default value, DefaultImageStyle.
	ResetPreserveImageAspectRatio	Resets the value of the PreserveImageAspectRatio property to its default value, DefaultPreserveImageAspectRatio.
	ResetReportStyle	Resets the property values of the ReportStyle.
	ResetTextPadding	Resets the value of the TextPadding property to its default value, DefaultTextPadding.
	ToString	Returns a string that represents the current object.

Top

Protected Methods

	Name	Description
	CalculateAreas	Calculates the text and image areas of the cell viewer.
	CalculateControlBounds	Calculates the bounds of the viewer and raises the QueryControlBounds event.
	CalculateControlBoundsCore	Calculates the bounds of the viewer.
	Finalize	Allows the object to attempt to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
	GetAccessibleText	Retrieves the viewer's accessibilty text for the specified Xceed.Grid.Cell and raises the QueryAccessibleText event.
	GetAccessibleTextCore	Retrieves the viewer's accessibilty text for the specified Xceed.Grid.Cell.
	GetFittedHeight	Retrieves a value representing the fitted height of the viewer in pixels and raises the QueryFittedHeight event.
	GetFittedHeightCore	Retrieves a value representing the fitted height of the viewer in pixels.
	GetFittedWidth	Retrieves a value representing the fitted width of the viewer in pixels and raises the QueryFittedWidth event.
	GetFittedWidthCore	Retrieves a value representing the fitted width of the viewer in pixels.
	GetImageCore	Retrieves the image displayed by the viewer.
	GetPropertyValue	Retrieves the value of the specified property in the Properties collection.
	GetService	Returns an object that represents a service provided by the System.ComponentModel.Component or by its Container.
	GetTextCore	Retrieves the text displayed by the viewer.
	IsPropertyDefined	Retrieves a boolean value indicating if the specified property has been explicitly set.
	OnImageAlignmentChanged	Raises the ImageAlignmentChanged event.
	OnImageAreaChanged	Raises the ImageAreaChanged event.
	OnImagePaddingChanged	Raises the ImagePaddingChanged event.
	OnImageSizeChanged	Raises the ImageSizeChanged event.
	OnImageStyleChanged	Raises the ImageStyleChanged event.
	OnPreserveImageAspectRatioChanged	Raises the PreserveImageAspectRatioChanged event.
	OnTextPaddingChanged	Raises the TextPaddingChanged event.
	PaintCellBackground	Paints the background of the cell.
	PaintCellForeground	Paints the foreground of the cell.
	RaiseEvent	Raises the specified event.
	RemovePropertyValue	Removes the specified property from the Properties collection.
	SetControlAppearance	Sets the underlining Control's appearance and raises the SettingControlAppearance event.
	SetControlAppearanceCore	Sets the underlining Control's appearance.
	SetControlValue	Assigns the cell's value to the Control and raises the SettingControlValue event.
	SetControlValueCore	Assigns the cell's value to the Control.

Top

Public Events

	Name	Description
	Disposed	Represents the method that handles the Disposed event of a component.
	ImageAlignmentChanged	Raised when the value of the ImageAlignment property is changed.
	ImageAreaChanged	Raised when the value of the ImageArea property is changed.
	ImagePaddingChanged	Raised when the value of the ImagePadding property is changed.
	ImageSizeChanged	Raised when the value of the ImageSize property is changed.
	ImageStyleChanged	Raised when the value of the ImageStyle property is changed.
	Paint	Raised after the cell's background and foreground have been painted.
	PreserveImageAspectRatioChanged	Raised when the value of the PreserveImageAspectRatio property is changed.
	QueryAccessibleText	Raised when retrieving a cell's accessibility text.
	QueryControlBounds	Raised when calculating the bounds of the control.
	QueryFittedHeight	Raised to calculate the fitted height of the viewer in pixels.
	QueryFittedWidth	Raised to calculate the fitted width of the viewer in pixels.
	QueryImage	Raised when retrieving the image displayed by the cell viewer.
	QueryText	Raised when retrieving the text displayed by the cell viewer.
	SettingControlAppearance	Raised when the appearance of the underlining control is about to be set.
	SettingControlValue	Raised when the value of a cell is being assigned to the underlining Control.
	TextPaddingChanged	Raised when the value of the TextPadding property is changed.

Top

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

CellViewerManager Members
Xceed.Grid.Viewers Namespace

Send Feedback

Business Suite

Ultimate Suite

Reference