Field Class

Field Class

DataPA OpenAnalytics API Reference

Inheritance Hierarchy

SystemObject
DataPA.Utils.QueryEngineField

Namespace: DataPA.Utils.QueryEngine
Assembly: DataPAQueryEngine (in DataPAQueryEngine.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

JavaScript

Copy

public class Field : _Field, ISerializable

Public Class Field
	Implements _Field, ISerializable

public ref class Field : _Field, ISerializable

DataPA.Utils.QueryEngine.Field = function();

Type.createClass(
	'DataPA.Utils.QueryEngine.Field',
	null,
	DataPA.Utils.QueryEngine.Field._Field,
	DataPASerialization.ISerializable);

The Field type exposes the following members.

Constructors

	Name	Description
	Field	Creates and returns a new Fields object

Top

Methods

	Name	Description
	Clone	Creates and returns a clone of this object
	Clone(String, String)	Creates and returns a clone of this object
	ComparibleDataType	Returns a value that indicates if a given data type can be compared with the current objects data type
	Duplicate	Copies all of the field properties from a given field to this field object
	Equals	Determines whether the specified object is equal to the current object (Overrides ObjectEquals(Object).)
	GetHashCode	Serves as the default hash code function (Overrides ObjectGetHashCode.)
	GetObjectData

Top

Fields

	Name	Description
	ClassId
	EventsId
	InterfaceId

Top

Properties

	Name	Description
	AllowCondition	Gets and sets a value that indicates if this field can be used in a condition.
	AllowContains	Gets and sets a value that indicates if this field supports the contains operator.
	AllowSort	Gets and sets a value that indicates if this field can be used for sorting.
	AnalyticsID	Gets and sets an identifier that identifies this field in the underlying analytics provider
	AnalyticsType	Gets and sets an enumerated type value that determines the analytics type of this field
	Ascending	Gets and sets a value that indicates the sort direction for this field
	Buffer	Gets and sets the containing buffer for this field
	DataType	Gets and sets the server type of this field
	DateGroupType	Gets and sets a value that indicates how dates will be grouped for this column
	Description	Gets and sets a description for this field.
	Expression	Gets and sets the expression for this field.
	Extent	Gets and sets a value that indicates the extent of this field.
	Format	Gets and sets a format for this field.
	IncludeOthers	Gets and sets a value that indicates whether other groups should be included in a collective group when they fall outside an applied top or bottom N
	IncludeTies	Gets and sets a value that indicates if ties should be included in the top/bottom N groupings
	Label	Gets and sets the label for this field
	Lookup	Gets and sets the lookup for this field.
	Mandatory	Gets and sets a value that indicates whether the condition for this field is mandatory.
	Name	Gets and sets the name of this field.
	ObjectSizes	Gets a dictionary of serialized objects contained in this object, along with their sizes (in bytes)
	OthersLabel	Gets and sets the label to be used for a collective group when they fall outside an applied top or bottom N
	ServerFormat	Gets and sets the server format string for this query.
	ShowGroupType	Gets and sets a value that indicates which group column values should be shown in a summary query
	StartingMonth	Gets and sets the starting month used to resolve date time periods
	StartingWeek	Gets and sets the starting week used to resolve date time periods
	StartingWeekday	Gets and sets the starting weekday used to resolve date time periods
	SubjectDataType	Gets the Subject data type of this field
	SubjectFieldName	Gets and sets the subject field field name of this field.
	SubjectLabel	Gets and sets the subject field label of this field.
	SummaryType	Gets and sets a value that expresses whether this column is used to group by, or how its summary value is calculated
	TopN	Gets and sets the value N used to apply top/bottom N group types
	TopNSumColumn	Gets and sets the name of the column used to apply top/bottom N group types
	Width	Gets and sets the width of this field.

Top

Reference

DataPA.Utils.QueryEngine Namespace