Class FormDef

Namespace

Tripous.Desktop

Assembly

Tripous.Desktop.dll

Describes a form

public class FormDef : BaseDef, IDef, IJsonLoadable, INotifyPropertyChanged

Inheritance

object

BaseDef

FormDef

Implements

IDef

IJsonLoadable

INotifyPropertyChanged

Inherited Members

BaseDef.fTitleKey

BaseDef.fName

BaseDef.NotifyPropertyChanged(string)

BaseDef.ToString()

BaseDef.UpdateReferences()

BaseDef.JsonLoaded()

BaseDef.CreateNew()

BaseDef.CheckDescriptor()

BaseDef.Assign(IDef)

BaseDef.Clone()

BaseDef.Clear()

BaseDef.SplitTitleKeyToWordsWithPluralEnding()

BaseDef.Name

BaseDef.TitleKey

BaseDef.IsTitleKeyEmpty

BaseDef.Title

BaseDef.Tag

BaseDef.IsSerializable

BaseDef.PropertyChanged

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

TypeExtensions.InheritsFrom(object, Type)

Properties

ClassName

The class name of the Type this descriptor describes.

NOTE: The value of this property may be a string returned by the AssemblyQualifiedName property of the type.

In that case, it consists of the type name, including its namespace, followed by a comma, followed by the display name of the assembly the type belongs to. It might looks like the following

Tripous.Data.DataModule, Tripous, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null

Otherwise it can be a full type name FullName, e.g.

Tripous.Data.DataModule

public string ClassName { get; set; }

Property Value

string

FactBoxes

The FactBoxes displayed by the item page of this form.

public DefList<ItemFactBoxDef> FactBoxes { get; }

Property Value

DefList<ItemFactBoxDef>

Group

The group this form belongs to.

Used in creating groups of Command lists.

public string Group { get; set; }

Property Value

string

IsReadOnly

When true then no edits are allowed.

public bool IsReadOnly { get; set; }

Property Value

bool

ItemClassName

The class name of the Type of the item part user control.

NOTE: The value of this property may be a string returned by the AssemblyQualifiedName property of the type.

In that case, it consists of the type name, including its namespace, followed by a comma, followed by the display name of the assembly the type belongs to. It might looks like the following

Tripous.Data.DataModule, Tripous, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null

Otherwise it can be a full type name FullName, e.g.

Tripous.Data.DataModule

public string ItemClassName { get; set; }

Property Value

string

Module

The registration name of the module this form uses.

public string Module { get; set; }

Property Value

string

ReferenceMenuClassName

Common context menu for controls that edit reference values, such as lookup and locator controls.

public string ReferenceMenuClassName { get; set; }

Property Value

string

SecurityLevel

Gets or sets the minimum user level required to access this form.

public UserLevel SecurityLevel { get; set; }

Property Value

UserLevel

Methods

CanAccess(AppUser)

Returns true when the specified user may access this form.

public bool CanAccess(AppUser User)

Parameters

User AppUser

Returns

bool

Create()

Creates a form instance as described by this instance.

public DataForm Create()

Returns

DataForm

CreateReferenceContextMenu()

Creates a reference context menu.

public ReferenceContextMenu CreateReferenceContextMenu()

Returns

ReferenceContextMenu

CreateShowCommand(Func<Command, object>, string)

Creates a command that displays the form.

public Command CreateShowCommand(Func<Command, object> ExecuteFunc = null, string ImageFileName = null)

Parameters

ExecuteFunc Func<Command, object>

The command execution callback.

ImageFileName string

The command image file name.

Returns

Command

The created command.

GetTitleKey()

Returns the title key for this instance.

protected override string GetTitleKey()

Returns

string