Table of Contents

Class DataPageBase

Namespace
Sage.CRM.WebObject
Assembly
SageCRMNet.dll

Abstract class for all Data Pages.

public abstract class DataPageBase : Web
Inheritance
DataPageBase
Derived
Inherited Members

Constructors

DataPageBase(string, string, string)

Initializes a new instance of DataPageBase.

public DataPageBase(string entityName, string idField, string screenName)

Parameters

entityName string

Entity Name.

idField string

Entity ID Field.

screenName string

Screen Name.

DataPageBase(string, string)

Initializes a new instance of DataPageBase.

public DataPageBase(string entityName, string idField)

Parameters

entityName string

Entity Name.

idField string

Entity ID Field.

Fields

_dataPageType

Defines the data page type.

protected string _dataPageType

Field Value

string

EditMethod

Default method name that retrieves the Edit page in a custom Dll when the user chooses to edit a record. This is the name applied when a Custom Dll is created using the SDK wizard. The value can be changed if you need to access another method.

public string EditMethod

Field Value

string

Properties

AssignedToTeamId

ID of the team to which the record is assigned, this is set automatically during BuildContents.

public int AssignedToTeamId { get; }

Property Value

int

AssignedToUserId

ID of the user to whom the record is assigned, this is set automatcially during BuildContents.

public int AssignedToUserId { get; }

Property Value

int

CreatedByUserId

ID of the user who created the current record, this is set automatically during BuildContents.

public int CreatedByUserId { get; }

Property Value

int

EntryGroups

List of EntryGroups on this page. EntryGroups[0] is automatically added by the constructor and represents the main Entity on Page. The ID property is used to get or set the ID of this EntryGroup.

public List<EntryGroup> EntryGroups { get; }

Property Value

List<EntryGroup>

Id

ID of the current record being edited.

public int Id { get; set; }

Property Value

int

TerritoryId

TerritoryId of the current record, this is set automatically during BuildContents.

public int TerritoryId { get; }

Property Value

int

Title

String to show as the title of the page. The property UseTabs should be disabled if the Title be used.

public string Title { get; set; }

Property Value

string

UseEntityTabs

In the base BuildContents functions you can control what tabs are drawn. Set this to true if you want to use EntityName on get tabs function. The default value for this property is false.

public bool UseEntityTabs { get; set; }

Property Value

bool

UseTabs

In the base BuildContents functions you can control whether tabs are drawn or not. Set this to false if you don't want tabs on the page. The default is true.

public bool UseTabs { get; set; }

Property Value

bool

UseWorkflow

Enables or Disable the Workflow on the page.

public bool UseWorkflow { get; set; }

Property Value

bool

Methods

AddEntryGroup(string, bool, int, int, string)

Adds a new EntryGroup to the page.

Name of EntryGroup from with CRM Admin customization. True if this EntryGroup should appear on a new line. Number of rows this EntryGroup should take up. Number of columns this EntryGroup should take up. The title to display on top of the EntryGroup. The EntryGroup object that was added. 
public EntryGroup AddEntryGroup(string entryGroupName, bool newLine, int rows, int cols, string title)

Parameters

entryGroupName string
newLine bool
rows int
cols int
title string

Returns

EntryGroup

AddEntryGroup(string, string)

Add EntryGroup with default position values, setting a title.

public EntryGroup AddEntryGroup(string entryGroupName, string title)

Parameters

entryGroupName string

Name of EntryGroup from with CRM Admin customization.

title string

Title to display on top of the EntryGroup when it is drawn.

Returns

EntryGroup

The EntryGroup object that was added.

AddEntryGroup(string)

Add EntryGroup with default position values. Use this to build up the array of EntryGroups that are to be displayed.

public EntryGroup AddEntryGroup(string entryGroupName)

Parameters

entryGroupName string

Name of EntryGroup from with CRM Admin customization.

Returns

EntryGroup

The EntryGroup object that was added.

BuildContents()

This is the main control method for the ListPage. It adds the tabs, and the <FORM> tag, draws the EntryGroup and the list and the buttons. Override this to change the behaviour.

public override void BuildContents()

GetEntryGroupByName(string)

Gets the EntryGroup object that has this name.

public EntryGroup GetEntryGroupByName(string entryGroupName)

Parameters

entryGroupName string

Name of EntryGroup to return.

Returns

EntryGroup

EntryGroup object.

ToUIObject()

Method invoked when the API tries to convert the Data Page to a HTML String.

public virtual VerticalPanel ToUIObject()

Returns

VerticalPanel

VerticalPanel with the EntryGroups Objects.

Url(string)

Creates a URL for a specified action. If the ContentIdField name is filled in then this will be appended to the url.

public override string Url(string action)

Parameters

action string

Returns

string