C1.Document Namespace

In This Topic

Classes

	Class	Description
	ArcShape	Represents an arc shape in a C1FlexReport.
	BarcodeOptions	Definies additional barcode options.
	BarcodeSizeOptions	Specifies the options affecting the size of a barcode, such as the width of narrow bars, narrow to wide bars' ratio etc.
	Border	Represents a border of object.
	C1BookmarkPosition	Represents a position of a bookmark within a document.
	C1Brush	Abstract base class for brushes used in C1Document and C1FlexReport.
	C1Document	Represents a ComponentOne Document.
	C1DocumentAction	Represents an action which can be executed by the C1DocumentSource and change its content, see C1DocumentSource.ExecuteAction.
	C1DocumentSource	Abstract base class for types that can create and manage a C1Document object from some source. Derived classes provide implementation for specific sources such as SSRS reports etc. The common base (C1DocumentSource) allows to work with various document and reports types (e.g. previewing or printing them) in a uniform manner.
	C1DocumentSourceContext	For internal use. Abstract class representing the full context in which a C1DocumentSource operates. Instances of this class can be used to save and restore the current state of a C1DocumentSource, for example it can be used to implement forward and backward navigation. For details see C1DocumentSource.GetContext and C1DocumentSource.SetContext methods. Derived classes should override Equals(...) and GetHashCode(...).
	C1DocumentSourceException	Represents an exception that occurred in a C1DocumentSource.
	C1DocumentSourceFeatures	Represents a set of features which are supported by a specific instance of the C1DocumentSource class. A client using that instance can analyse the properties exposed by this type, and enable or disable the UI elements accordingly.
	C1FindTextParams	Represents find text parameters.
	C1FoundPosition	Represents a position in a document where a text was found.
	C1FragmentHighlight	Defines highlighting in the block of text.
	C1GradientBrush	Abstract base class for various gradient brushes.
	C1Hyperlink	Represents a hyperlink in a document. A hyperlink may be assigned to a RenderObject's RenderObject.Hyperlink, or a RenderParagraphObject's RenderParagraphObject.Hyperlink property. In that case clicking on that object in a viewer will jump to the hyperlink's LinkTarget.
	C1KeyedList<TKey,TItem>	Represents the pages of document.
	C1LinearBrush	Defines a linear gradient brush.
	C1LinkTarget	Defines a link to another document or a location within the same document.
	C1LinkTargetBase	Abstract base class for classes defining a link target.
	C1LinkTargetFile	Describes a C1LinkTarget pointing to an external document, file or URL. The hyperlink jump is performed using the ShellExecute OS shell API, so the result depends on the operating system and installed programs.
	C1LinkTargetPage	Defines a link to another document or a location within the same document via page index and area within the page.
	C1PageSettings	Represents the page settings of a C1Document.
	C1PdfDocumentSource	Represents a document source which loads and renders PDF documents.
	C1PrintOptions	Describes options controlling how a document's content is to be printed.
	C1RadialBrush	Defines a radial gradient brush.
	C1RplImportException	Represents an exception that occurred during RPL import.
	C1SolidBrush	Defines a brush of a single color.
	C1SortedList<TKey,TValue>	The sorted list class.
	C1SSRSDocumentSource	Represents a document source to access an SSRS report.
	C1TextSearchManager	Provides functionality to search text in the document managed by the C1DocumentSource.
	CompatibilityOptions	Defines the compatibility options for C1PrintDocument. Contains properties specifying compatibility with previous versions of C1PrintDocument.
	DocumentInfo	Represents general information about a C1Document, such as author, subject, creation date and time, and so on. Can be accessed via the C1Document.DocumentInfo property on a document.
	EllipsePartShape	Abstract base class for ArcShape and PieShape classes.
	EllipseShape	Represents an ellipse shape in C1FlexReport.
	ExecuteActionCompletedEventArgs	Provides data for the C1DocumentSource.ExecuteActionCompleted event.
	ExportCompletedEventArgs	Provides data for the C1DocumentSource.ExportCompleted event.
	FindActionCompletedEventArgs	Defines parameters for a C1TextSearchManager.FindActionCompleted event.
	GetLinkTargetPositionCompletedEventArgs	Provides data for the C1DocumentSource.GetLinkTargetPositionCompleted event.
	GetPageCompletedEventArgs	Provides data for the C1DocumentSource.GetPageCompleted event.
	GradientStop	Defines the point within gradient.
	IsoscelesTriangleShape	Represents an isosceles triangle shape in C1FlexReport.
	LabeledValue	Represents a value with a label. The label can be used in a UI.
	LabeledValues	Represents a collection of LabeledValue objects.
	Line	Represents a line in C1Document and "C1FlexReport". This class is used to specifiy borders in the Border class, line style used by shapes, and so on.
	LineShape	Represents a line shape in a C1FlexReport.
	LineShapeBase	Abstract base class for LineShape class.
	LogEntry	The log entry description.
	LogEntryList	The list of the log entry elements.
	LongOperationEventArgs	Describes arguments for the event fired periodically by a potentially long operation. Allows to provide feedback to the user and may also allow to cancel the operation.
	NotifyCollectionEventArgs	Provides data for the INotifyCollection.CollectionChanged and INotifyCollection.CollectionChanging events.
	OutputRange	Describes a part of the document (pages or objects) that is to be exported or printed. Note: all page numbers are 1-based.
	PagesLoadedEventArgs	Contains event data for events fired when some pages have been loaded and their content became available. Represents a contiguous range of pages defined by the first page's index, and the number of pages in the range.
	ParameterValidationError	Represents an error which occurred while validating parameters of a C1DocumentSource.
	PdfPasswordException	The exception that is thrown when the value provided as the current password is incorrect.
	PieShape	Represents a pie shape in a C1FlexReport.
	PolygonShape	Represents a polygon shape in C1FlexReport.
	PropertyNotifyEventArgs	Provides data for the INotifyObject.PropertyChanged and INotifyObject.PropertyChanging events.
	RectangleShape	Represents a rectangle shape in C1FlexReport.
	RightTriangleShape	Represents a rectangular triangle shape in C1FlexReport.
	SecurityErrorEventArgs	Defines parameters for a C1DocumentSource.SecurityError event.
	SecurityException	Represents an exception caused by invalid credentials used in C1DocumentSource operation.
	ShapeBase	Abstract base class for shapes rendered by report fields. See ShapeType.
	SSRSDrillthroughReportLocation	Represents the location of an SSRS report specified via execution ID of master report and ID of the drillthrough report.
	SSRSOpenReportAction	Opens SSRS report from location specified by the SSRSReportLocationBase.
	SSRSReportLocation	Represents the location of an SSRS report specified by a full path to the report on a server.
	SSRSReportLocationBase	Abstract base class for types representing the location of an SSRS report.
	SSRSSessionReportLocation	Represents the location of an SSRS report specified by a report session ID.
	SSRSSortAction	Changes sorting in the currently opened report, see ReportExecutionService.Sort(...) for more detais.
	SSRSToggleItemAction	Toggles the show/hide item in the currently opened report, see ReportExecutionService.ToggleItem(string) for more details.
	TriangleShapeBase	Abstract base class for IsoscelesTriangleShape and RightTriangleShape types.
	Utils	Contains common functions.
	ValidateParametersCompletedEventArgs	Provides data for the C1DocumentSource.ValidateParametersCompleted event.
	VisualPrimitive	Abstract base class for classes representing various complex visual properties like Line, Border etc.

Interfaces

	Interface	Description
	IAsyncActionWithProgress<TProgress>	Represents an asynchronous action that includes progress updates.
	IAsyncInfo	Supports asynchronous actions and operations.
	IAsyncOperationWithProgress<TResult,TProgress>	Represents an asynchronous operation that includes progress updates.
	IC1KeyedItem<TKey>	Represents a single page of document.
	INotifyCollection	Notifies listeners of dynamic changes, such as when items get added and removed.
	INotifyObject	Notifies clients that a property value about to be changed or already has changed.

Structures

	Structure	Description
	BarcodeExRenderer.BarcodeMetrics	Metrics of barcode, units are pixels of C1.Document.Util.C1Graphics.
	C1HighlightAttrs	Defines attributes used to highlight content of document.
	C1TextRange	Represents a continuous range of text.
	CornerRadius	Defines the corners' radii of a rounded rectangle.
	Unit	A utility structure specifying some values related to units of measurement.

Delegates

	Delegate	Description
	AsyncActionProgressHandler<TProgress>	Represents a method that handles progress update events of an asynchronous action that provides progress updates.
	AsyncActionWithProgressCompletedHandler<TProgress>	Represents a method that handles the completed event of an asynchronous action that provides progress updates.
	AsyncOperationProgressHandler<TResult,TProgress>	Represents a method that handles progress update events of an asynchronous operation that provides progress updates.
	AsyncOperationWithProgressCompletedHandler<TResult,TProgress>	Represents a method that handles the completed event of an asynchronous operation that provides progress updates.
	LongOperationEventHandler	Represents a method that can handle a long operation event.
	NotifyCollectionEventHandler	Represents a method that handles the INotifyCollection.CollectionChanging or INotifyCollection.CollectionChanged events.
	PagesLoadedEventHandler	Defines a handler for the event fired when some pages have been loaded and their content is available.
	PropertyNotifyEventHandler	Represents the method that will handle the INotifyObject.PropertyChanged or INotifyObject.PropertyChanging events raised when a property is changed or chaning on an object.
	SecurityErrorEventHandler	Represents a method that will handle a C1DocumentSource.SecurityError event.

Enumerations

	Enumeration	Description
	AsyncStatus	Specifies the status of an asynchronous operation.
	BarCodeEnum	Determines the type of barcode.
	BarcodeSizeMode	Specifies the various barcode sizing modes.
	BordersSplitMode	Specifies how borders are drawn when the object is split between pages.
	C1DocumentSourceBusyState	Describes the busy state of a C1DocumentSource object.
	C1FindTextAction	Specifies the base position and direction of a text search.
	C1FontStretch	Represents the degree to which a font has been stretched compared to a font's normal aspect ratio.
	CollectionAction	Describes the action that caused a INotifyCollection.CollectionChanging or INotifyCollection.CollectionChanged events.
	DashStyle	Defines the dash style of a line.
	DocumentInfoFields	Enumerates the fields stored by the DocumentInfo class.
	LineSlantEnum	Defines how line is drawn within shape.
	LogEntrySeverity	The severity of the log entry.
	MeasurementDevice	Defines the device (printer or screen) used to measure the objects of a C1Document or C1FlexReport.
	OutputRangeType	Specifies the type of an OutputRange.
	PageScaling	Specifies the way pages are scaled during printing.
	ParameterType	Specifies the type of a value (e.g. in a Parameter.DataType).
	SearchScope	Specifies text search scope.
	ShapeType	Defines the shapes.
	StretchEnum	Defines how line is drawn within shape.
	TextFitMode	Specifies how a text is adjusted to fit in specified bounds.
	UnitTypeEnum	Enumerates units of measurement used in a C1Document, used by Unit and related types.
	WritingMode	Specifies whether a text is written horizontally or vertically.

Reference

C1.Document Assembly