PFExcelDataExporter_Source Class

This class represents a Packflow data source used to feed or synchronize Excel files.

It allows selecting a PFView or PFContentType as a data source.

This source is then consumed by PFExcelDataExporter or ExcelDataService

Inheritance Hierarchy

SystemObject
Packflow.Interface.OfficePFExcelDataExporter_Source

Namespace: Packflow.Interface.Office
Assembly: MicaSystems.Packflow.Interface (in MicaSystems.Packflow.Interface.dll) Version: 1.0.0.0 (2.0.0.223)

Syntax

Copy

[DataContractAttribute]
public sealed class PFExcelDataExporter_Source

The PFExcelDataExporter_Source type exposes the following members.

Constructors

	Name	Description
	PFExcelDataExporter_Source	Initializes a new instance of the PFExcelDataExporter_Source class.

Top

Properties

Name

Description

ContentType

Gets or sets selected source content-type. Selecting a view has priority over selecting a content-type.

ContextObjectId

Gets or sets the context object id for filtering item. if setting UserContextMode to ApplicationContext, this property should contain a valid application context id. If setting to ReferenceGroup, a reference group id should be set.

CurrentSite

Gets the current site this exporter belongs to.

CustomFieldRenderer

Gets or sets the custom field value renderer. Will be called in place of the PFItemHtmlHelper if not null and [!:Packflow.Interface.Office.PFExcelDataExporter_Source.UserFriendlyValues] is set true.

Note
This applies only to your object instance.

Hence,network data synchronization from excel won't call the delegate set here.

Fields

Gets or sets the fields to display when selecting a content-type.

View selection will use view fields instead.

SynchronizeData

Gets or sets a value indicating whether source should be network synchronised from excel to Packflow.

Note
This only applies to View selection. Network data synchronization for content-type selection is not implemented yet.

UseFriendlyValues

Gets or sets a value indicating whether rendering should use friendly values. Is set true, will use display text values for fields, Item's html helper or custom set renderer. CustomFieldRenderer

If set false, will use raw values. this is usefull for later importation.

UserContextMode

Gets or sets the user context mode used to filter items.

View

Gets or sets the selected view. Selecting a view has priority over selecting a content-type.

Top

Methods

	Name	Description
	CreateSource	Creates a PFEXcelDataExporter_Source from a ClosedXml table, serving as a template. Selects a Content-Type with a custom list of fields based on columns. The table name allows to find the content-type (ApplicationName.ContentTypeName
	GetAssociatedFields	Gets the fields associated with this source. In case of a view selection, returns the view's fields. If selecting a content-type
	GetColumnHeaderValue	Gets the text value for a specific field header. Returns the Name property in case of a Content-Type selection. Uses the DisplayName in case of View selection.
	GetItemFieldValue	Gets the text value for a specific field and item. The computed value depends on the UseFriendlyValues and CustomFieldRenderer delegate.
	GetRefreshQueryString	Gets the refresh query string parameters for the current instance settings.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	Parameter_AppContextId	The application context id query string parameter
	Parameter_AppId	The application id query string parameter
	Parameter_AppName	The application name query string parameter
	Parameter_CTId	The content-type id query string parameter
	Parameter_CTName	The content-type name query string parameter
	Parameter_ReferenceGroupId	The reference group query string parameter
	Parameter_ViewId	The view id query string parameter
	Parameter_ViewName	The view name query string parameter

Top

Extension Methods

	Name	Description
	AsT	Casts an object to another type. Returns default(T) if the object is null. (Defined by Utils_Other.)
	EqualsAll	Checks that this object is equal to every object in parameters. (Defined by Utils_Other.)
	EqualsAny	Checks that this object is equal to at least one of the parameters. (Defined by Utils_Other.)
	GetString	Converts an object to String using ToString() method, else returns String.Empty. (Defined by Utils_Other.)
	IsGenericList	Overloaded. Checks if this object is a System.Collections.Generic.List. (Defined by Utils_Linq.)
	IsGenericList(Type)	Overloaded. Checks if this object is a System.Collections.Generic.List using type as T. (Defined by Utils_Linq.)
	Serialize	Overloaded. Serializes an object into an XML document. (Defined by Utils_Xml.)
	Serialize(String)	Overloaded. Serializes an object into an XML document. (Defined by Utils_Xml.)
	SerializeJson	Overloaded. Serializes an object using a DataContractJsonSerializer. (Defined by Utils_String.)
	SerializeJson(ListType)	Overloaded. Serializes an object using a DataContractJsonSerializer. (Defined by Utils_String.)
	SerializeJson(DataContractJsonSerializerSettings)	Overloaded. Serializes an object using a DataContractJsonSerializer. (Defined by Utils_String.)

Top

Reference

Packflow.Interface.Office Namespace