Version

DataPresenterWordWriter Class Members

The following tables list the members exposed by DataPresenterWordWriter.

Public Constructors
 NameDescription
Public ConstructorDataPresenterWordWriter ConstructorInitializes a new DataPresenterWordWriter  
Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)AsyncExportDurationPropertyIdentifies the AsyncExportDuration dependency property  
Public Fieldstatic (Shared in Visual Basic)AsyncExportIntervalPropertyIdentifies the AsyncExportInterval dependency property  
Public Fieldstatic (Shared in Visual Basic)CellSettingsForDataRecordPropertyCellSettingsForDataRecord Attached Dependency Property  
Public Fieldstatic (Shared in Visual Basic)CellSettingsForExpandableFieldRecordPropertyCellSettingsForExpandableFieldRecord Attached Dependency Property  
Public Fieldstatic (Shared in Visual Basic)CellSettingsForGroupByRecordPropertyCellSettingsForGroupByRecord Attached Dependency Property  
Public Fieldstatic (Shared in Visual Basic)CellSettingsForLabelPropertyCellSettingsForLabel Attached Dependency Property  
Public Fieldstatic (Shared in Visual Basic)CellSettingsForSummaryRecordPropertyCellSettingsForSummaryRecord Attached Dependency Property  
Public Fieldstatic (Shared in Visual Basic)DefaultFontSettingsPropertyIdentifies the DefaultFontSettings dependency property  
Public Fieldstatic (Shared in Visual Basic)DefaultParagraphSettingsPropertyIdentifies the DefaultParagraphSettings dependency property  
Public Fieldstatic (Shared in Visual Basic)DefaultTableSettingsPropertyIdentifies the DefaultTableSettings dependency property  
Public Fieldstatic (Shared in Visual Basic)DocumentSettingsPropertyIdentifies the DocumentSettings dependency property  
Public Fieldstatic (Shared in Visual Basic)ExcludeCrossFieldRecordFiltersPropertyIdentifies the ExcludeCrossFieldRecordFilters dependency property  
Public Fieldstatic (Shared in Visual Basic)ExcludeExpandedStatePropertyIdentifies the ExcludeExpandedState dependency property  
Public Fieldstatic (Shared in Visual Basic)ExcludeFieldLayoutSettingsPropertyIdentifies the ExcludeFieldLayoutSettings dependency property  
Public Fieldstatic (Shared in Visual Basic)ExcludeFieldSettingsPropertyIdentifies the ExcludeFieldSettings dependency property  
Public Fieldstatic (Shared in Visual Basic)ExcludeGroupBySettingsPropertyIdentifies the ExcludeGroupBySettings dependency property  
Public Fieldstatic (Shared in Visual Basic)ExcludeRecordFiltersPropertyIdentifies the ExcludeRecordFilters dependency property  
Public Fieldstatic (Shared in Visual Basic)ExcludeRecordVisibilityPropertyIdentifies the ExcludeRecordVisibility dependency property  
Public Fieldstatic (Shared in Visual Basic)ExcludeSortOrderPropertyIdentifies the ExcludeSortOrder dependency property  
Public Fieldstatic (Shared in Visual Basic)ExcludeSummariesPropertyIdentifies the ExcludeSummaries dependency property  
Public Fieldstatic (Shared in Visual Basic)FinalSectionSettingsPropertyIdentifies the FinalSectionSettings dependency property  
Public Fieldstatic (Shared in Visual Basic)IgnoreFieldPropertyIgnoreField Attached Dependency Property  
Public Fieldstatic (Shared in Visual Basic)IsExportingPropertyIdentifies the IsExporting dependency property  
Public Fieldstatic (Shared in Visual Basic)ShowAsyncExportStatusPropertyIdentifies the ShowAsyncExportStatus dependency property  
Public Fieldstatic (Shared in Visual Basic)TableSettingsForFieldLayoutPropertyTableSettingsForFieldLayout Attached Dependency Property  
Public Properties
 NameDescription
Public PropertyAsyncExportDurationReturns or sets the amount of time that should be spent processing the export each time the AsyncExportInterval elapses.  
Public PropertyAsyncExportIntervalReturns or sets the amount of time to wait after performing an asynchronous export for the amount of time specified by the AsyncExportDuration.  
Public PropertyDefaultFontSettingsReturns/sets an object that is used to initialize the Infragistics.Documents.Word.WordDocumentWriter.DefaultFont when the exporter creates the writer.  
Public PropertyDefaultParagraphSettingsReturns/sets an object that is used to initialize the Infragistics.Documents.Word.WordDocumentWriter.DefaultTableProperties when the exporter creates the writer.  
Public PropertyDefaultTableSettingsReturns/sets an object that is used to initialize the Infragistics.Documents.Word.WordDocumentWriter.DefaultTableProperties when the exporter creates the writer.  
Public PropertyDependencyObjectTypeGets the System.Windows.DependencyObjectType that wraps the CLR type of this instance. (Inherited from System.Windows.DependencyObject)
Public PropertyDispatcherGets the System.Windows.Threading.Dispatcher this System.Windows.Threading.DispatcherObject is associated with. (Inherited from System.Windows.Threading.DispatcherObject)
Public PropertyDocumentSettingsReturns/sets an object that is used to initialize the Infragistics.Documents.Word.WordDocumentWriter.DocumentProperties when the exporter creates the writer.  
Public PropertyExcludeCrossFieldRecordFiltersDetermines if cross field record filter criteria of the DataPresenter is honored during the exporting process.  
Public PropertyExcludeExpandedStateReturns/sets a value indicating whether the expanded state of the source records will be copied to the records being exported.  
Public PropertyExcludeFieldLayoutSettingsReturns/sets a boolean indicating whether to copy the Infragistics.Windows.DataPresenter.FieldLayoutSettings from the control being exported.  
Public PropertyExcludeFieldSettingsReturns/sets a boolean indicating whether to copy the Infragistics.Windows.DataPresenter.FieldSettings from the control being exported.  
Public PropertyExcludeGroupBySettingsReturns/sets a boolean indicating whether to copy the GroupBy state of the fields from the control being exported.  
Public PropertyExcludeRecordFiltersReturns/sets a boolean indicating whether to copy the RecordFilter state of the fields from the control being exported.  
Public PropertyExcludeRecordVisibilityReturns/sets a boolean indicating whether to copy the Visibility setting of the records from the control being exported.  
Public PropertyExcludeSortOrderReturns/sets a boolean indicating whether to copy the sorted fields from the control being exported.  
Public PropertyExcludeSummariesReturns/sets a boolean indicating whether to copy the summaries of the FieldLayouts from the control being exported.  
Public PropertyFinalSectionSettingsReturns/sets an object that is used to initialize the Infragistics.Documents.Word.WordDocumentWriter.FinalSectionProperties when the exporter creates the writer.  
Public PropertyIsExportingReturns a boolean indicating if the exporter is in the process of an export operation.  
Public PropertyIsSealedGets a value that indicates whether this instance is currently sealed (read-only). (Inherited from System.Windows.DependencyObject)
Public PropertyShowAsyncExportStatusReturns or sets a value that indicates whether a control containing the export status is displayed to the end user while an asynchronous export is in progress.  
Public Methods
 NameDescription
Public MethodCancelExportCancels any asynchronous export operations for the specified Infragistics.Windows.DataPresenter.DataPresenterBase that were initiated by this instance.  
Public MethodClearValueOverloaded. Clears the local value of a property. The property to be cleared is specified by a System.Windows.DependencyProperty identifier. (Inherited from System.Windows.DependencyObject)
Public MethodCoerceValueCoerces the value of the specified dependency property. This is accomplished by invoking any System.Windows.CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling System.Windows.DependencyObject. (Inherited from System.Windows.DependencyObject)
Public MethodEquals (Inherited from System.Windows.DependencyObject)
Public MethodExportOverloaded. Exports the specified DataPresenter derived control to the specified file.  
Public MethodExportAsyncOverloaded. Asynchronously exports the specified DataPresenter derived control to the specified file.  
Public Methodstatic (Shared in Visual Basic)GetCellSettingsForDataRecordReturns the format settings applied to Word Table Cell that represents a given field.  
Public Methodstatic (Shared in Visual Basic)GetCellSettingsForExpandableFieldRecordReturns the format settings applied to Word Table Cell that represents an Infragistics.Windows.DataPresenter.ExpandableFieldRecord header.  
Public Methodstatic (Shared in Visual Basic)GetCellSettingsForGroupByRecordReturns the format settings applied to Word Table Cells that represents a Infragistics.Windows.DataPresenter.GroupByRecord.  
Public Methodstatic (Shared in Visual Basic)GetCellSettingsForLabelReturns the format settings applied to a Infragistics.Windows.DataPresenter.FieldItem.Label when exported to word.  
Public Methodstatic (Shared in Visual Basic)GetCellSettingsForSummaryRecordReturns the format settings applied to Word Table Cells that represents a Infragistics.Windows.DataPresenter.SummaryRecord.  
Public MethodGetHashCodeGets a hash code for this System.Windows.DependencyObject. (Inherited from System.Windows.DependencyObject)
Public Methodstatic (Shared in Visual Basic)GetIgnoreFieldGets the IgnoreField property. This dependency property indicates whether the specified field should be collapsed/excluded from an export to Word using the DataPresenterWordWriter.  
Public MethodGetLocalValueEnumeratorCreates a specialized enumerator for determining which dependency properties have locally set values on this System.Windows.DependencyObject. (Inherited from System.Windows.DependencyObject)
Public Methodstatic (Shared in Visual Basic)GetTableSettingsForFieldLayoutReturns the format settings applied to a Infragistics.Windows.DataPresenter.FieldLayout when exported to word.  
Public MethodGetValueReturns the current effective value of a dependency property on this instance of a System.Windows.DependencyObject. (Inherited from System.Windows.DependencyObject)
Public MethodInvalidateProperty (Inherited from System.Windows.DependencyObject)
Public MethodReadLocalValueReturns the local value of a dependency property, if it exists. (Inherited from System.Windows.DependencyObject)
Public Methodstatic (Shared in Visual Basic)SetCellSettingsForDataRecordSets the format settings applied to a Infragistics.Windows.DataPresenter.Cell when exported to word.  
Public Methodstatic (Shared in Visual Basic)SetCellSettingsForExpandableFieldRecordSets the format settings applied to a Infragistics.Windows.DataPresenter.ExpandableFieldRecord when exported to word.  
Public Methodstatic (Shared in Visual Basic)SetCellSettingsForGroupByRecordSets the format settings applied to Word Table Cells that represents a Infragistics.Windows.DataPresenter.GroupByRecord.  
Public Methodstatic (Shared in Visual Basic)SetCellSettingsForLabelSets the format settings applied to a Infragistics.Windows.DataPresenter.FieldItem.Label when exported to word.  
Public Methodstatic (Shared in Visual Basic)SetCellSettingsForSummaryRecordSets the format settings applied to Word Table Cells that represents a Infragistics.Windows.DataPresenter.SummaryRecord.  
Public MethodSetCurrentValue (Inherited from System.Windows.DependencyObject)
Public Methodstatic (Shared in Visual Basic)SetIgnoreFieldSets the IgnoreField property. This dependency property indicates whether the associated field should be collapsed/excluded from an export to Word using the DataPresenterWordWriter.  
Public Methodstatic (Shared in Visual Basic)SetTableSettingsForFieldLayoutSets the format settings applied to a Infragistics.Windows.DataPresenter.FieldLayout when exported to word.  
Public MethodSetValueOverloaded. Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from System.Windows.DependencyObject)
Protected Methods
 NameDescription
Protected Internal MethodOnCellExportingUsed to invoke the CellExporting event.  
Protected Internal MethodOnExportEndedUsed to invoke the ExportEnded event.  
Protected Internal MethodOnExportEndingUsed to invoke the ExportEnding event.  
Protected Internal MethodOnExportStartedUsed to invoke the ExportStarted event.  
Protected Internal MethodOnInitializeRecordUsed to invoke the InitializeRecord event.  
Protected Internal MethodOnLabelExportingUsed to invoke the LabelExporting event.  
Protected MethodOnPropertyChangedInvoked whenever the effective value of any dependency property on this System.Windows.DependencyObject has been updated. The specific dependency property that changed is reported in the event data. (Inherited from System.Windows.DependencyObject)
Protected Internal MethodOnSummaryResultsExportingUsed to invoke the SummaryResultsExporting event.  
Protected Internal MethodShouldSerializePropertyReturns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from System.Windows.DependencyObject)
Public Events
 NameDescription
Public EventCellExportingOccurs when a Infragistics.Windows.DataPresenter.Cell of a Infragistics.Windows.DataPresenter.DataRecord is about to be written to the Word document.  
Public EventExportEndedOccurs after the export process has completed.  
Public EventExportEndingOccurs at the end of the export process.  
Public EventExportStartedOccurs at the beginning of the export process. The ExportStartedEventArgs.ExportControl has been initialized but the Infragistics.Windows.DataPresenter.DataPresenterBase.DataSource has not yet been set.  
Public EventInitializeRecordOccurs when a record is about to be processed.  
Public EventLabelExportingOccurs when the Field.Label of a Infragistics.Windows.DataPresenter.Field is about to be written to the Word document.  
Public EventSummaryResultsExportingOccurs when one or more Infragistics.Windows.DataPresenter.SummaryResult instances are being written to the Word document.  
See Also