Show / Hide Table of Contents

Class UiEvent

An event that the user interface should know about. The origin may be something that happens in the user interface (in any session), or in the database (for instance, background process)

Carrier object for UiEvent. Services for the UiEvent Carrier is available from the IViewStateAgent.
Inheritance
Object
UiEvent
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class UiEvent : Carrier

Constructors

UiEvent()

Default constructor

Declaration
public UiEvent()
See Also
ViewStateAgent
IViewStateAgent

Properties

AssociateId

The ID of the associate causing the event

Declaration
public virtual int AssociateId { get; set; }
Property Value
Type Description
Int32
See Also
ViewStateAgent
IViewStateAgent

AssociateName

The full person name of the associate causing the event

Declaration
public virtual string AssociateName { get; set; }
Property Value
Type Description
String
See Also
ViewStateAgent
IViewStateAgent

EntityKey

Primary key of entity the event concerns

Declaration
public virtual int EntityKey { get; set; }
Property Value
Type Description
Int32
See Also
ViewStateAgent
IViewStateAgent

EntityType

Name of entity, for instance 'ticket'

Declaration
public virtual string EntityType { get; set; }
Property Value
Type Description
String
See Also
ViewStateAgent
IViewStateAgent

EventDateTime

When did the event happen

Declaration
public virtual DateTime EventDateTime { get; set; }
Property Value
Type Description
DateTime
See Also
ViewStateAgent
IViewStateAgent

EventId

Id of event, increasing in chronological order, assigned by server

Declaration
public virtual int EventId { get; set; }
Property Value
Type Description
Int32
See Also
ViewStateAgent
IViewStateAgent

EventName

Name of event, for instance 'change' or 'edit'

Declaration
public virtual string EventName { get; set; }
Property Value
Type Description
String
See Also
ViewStateAgent
IViewStateAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.

See Also
ViewStateAgent
IViewStateAgent

ToString(String)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
String prefix

The line prefix (typically used for indenting)

Returns
Type Description
String

The carrier contents.

See Also
ViewStateAgent
IViewStateAgent

See Also

ViewStateAgent
IViewStateAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top