Table of Contents

Class DataPage

Namespace
Sage.CRM.WebObject
Assembly
SageCRMNet.dll

A page used to view an existing record. Diplays Edit and Continue buttons.

public class DataPage : DataPageBase
Inheritance
DataPage
Inherited Members

Constructors

DataPage(string, string, string)

Initializes a new instance of DataPage.

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

Parameters

entityName string

Entity Name.

idField string

Entity ID Field.

screenName string

Screen Name.

DataPage(string, string)

Initializes a new instance of DataPage.

public DataPage(string entityName, string idField)

Parameters

entityName string

Entity Name.

idField string

Entity ID Field.

Fields

ContinueMethod

Default method name that retrieves the delete page in a Custom Dll's when user chooses to delete a record. This is the name applied when a Custom Dll is created using the SDK wizard. This value can be changed if you need another method accessed.

public string ContinueMethod

Field Value

string

EditMode

Obsolete

[Obsolete("Use the property Mode if necessary")]
public bool EditMode

Field Value

bool

Key

Obsolete

[Obsolete("This property will not be used")]
public int Key

Field Value

int

Properties

ContinueButton

String value to describe a button used on the page. Datapage has a ButtonsToExclude list. Add the name of this button if you do not want it rendered.

public bool ContinueButton { get; set; }

Property Value

bool

EditButton

String value to describe a button used on the page. Datapage has a ButtonsToExclude list. Add the name of this button if you do not want it rendered.

public bool EditButton { get; set; }

Property Value

bool

EntryGroupNames

Returns an array of the names of the EntryGroups that will be displayed on the page.

[Obsolete("This will not allow set ")]
public string[] EntryGroupNames { get; set; }

Property Value

string[]

isWorkflowPostBack

Return true if is this is a Workflow Post Back.

public bool isWorkflowPostBack { get; }

Property Value

bool

Methods

AddContinueButton()

Adds the standard Continue button to the page. Override this to remove or change behaviour of the Continue button. The default continue button will redirect to the same .NET dll, calling the "RunListPage" method.

public virtual void AddContinueButton()

AddEditButton()

Adds the standard edit button, if the user has rights to edit the current record. Override this to remove or change the edit button. The default edit button redirects to the same .NET dll, calling the "RunDataPageEdit" entry point method.

public virtual void AddEditButton()

AddMainTitle()

This is called in BuildContents method to display a title on the screen. Override this method to add content to the top of the DataPage.

[Obsolete("This method will not be used.")]
public virtual void AddMainTitle()

BuildContents()

Main control method for a DataPage - shows data in view mode with appropriate Edit/Delete/Continue buttons.

public override void BuildContents()

EntryGroups_GetHtml(Mode, Record)

This method is called from within the core BuildContents method to get the HTML that renders the data on the screen from a record object. Override this to add in your own HTML.

[Obsolete("Use the method ToUIObject")]
public virtual string EntryGroups_GetHtml(Mode iMode, Record info)

Parameters

iMode Mode

Can be Sage.Mode.View or Sage.Mode.Edit.

info Record

Record object that holds the data to be displayed.

Returns

string

HTML string.

EntryGroups_GetHtml(Mode, DataSource)

This method is called from within the core BuildContents method to get the HTML that renders the data on the screen. Override this to add your own HTML.

[Obsolete("Use the method ToUIObject")]
public virtual string EntryGroups_GetHtml(Mode iMode, DataSource source)

Parameters

iMode Mode

Can be Sage.Mode.View or Sage.Mode.Edit

source DataSource

Can be Sage.DataSource.FromContent or Sage.DataSource.FromDefault.

Returns

string

HTML string.

Screens_FillScreensArray()

Obsolete

[Obsolete("This method is obsotete")]
public void Screens_FillScreensArray()