Show / Hide Table of Contents

Class HistoryItem

Represents a history item, i.e. a contact or project from the history list.

Inheritance
Object
HistoryItem
Inherited Members
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.Cache
Assembly: SuperOffice.DCF.dll
Syntax
public class HistoryItem

Constructors

HistoryItem()

Default constructor

Declaration
public HistoryItem()

HistoryItem(Int32, String, String)

Init constructor

Declaration
public HistoryItem(int id, string name, string type)
Parameters
Type Name Description
Int32 id

The history item id, e.g. company id

String name

The history item name, e.g company name

String type

Extra info for the history item

Properties

HasChanged

True if the history item has changed since the last request. When updated to 'true', sentry information will evaporate.

Declaration
public bool HasChanged { get; set; }
Property Value
Type Description
Boolean

Id

The history item's id

Declaration
public int Id { get; set; }
Property Value
Type Description
Int32

Name

The history item's name

Declaration
public string Name { get; set; }
Property Value
Type Description
String

TableRight

Get the table rights for the entity, if available (you may get a null return value here)

Declaration
public TableRight TableRight { get; }
Property Value
Type Description
TableRight

Type

Extra type information on the history item

Declaration
public string Type { get; set; }
Property Value
Type Description
String

Methods

GetFieldRight(String)

Get the field right for a certain field; null is returned if the field does not exist or we just don't know (for instance, after HasChanged being set to true). This is a fast lookup.

Declaration
public FieldRight GetFieldRight(string fieldName)
Parameters
Type Name Description
String fieldName
Returns
Type Description
FieldRight

SetSentryInformation(TableRight, String[], FieldRight[])

Set the Sentry information

Declaration
public void SetSentryInformation(TableRight tableRight, string[] fieldNames, FieldRight[] fieldRights)
Parameters
Type Name Description
TableRight tableRight

Table rights of entity

String[] fieldNames

Names of fields

FieldRight[] fieldRights

Rights of fields, corresponding to names by position

ToString()

Represents a history item, i.e. a contact or project from the history list.

Declaration
public override string ToString()
Returns
Type Description
String
Overrides
object.ToString()
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top