Class repControl

Namespace

PolarStudio

Assembly

PolarStudio.dll

This class contains the information about a control in the Polar Studio repository.

public class repControl

Inheritance

object

repControl

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Globals.IsNumericType(object)

Properties

ControlType

Returns the type of control (as string). This is a combination of the main control type and the sub control type, like 'TEXTBOX' or 'TABSHEET!START'

public string ControlType { get; }

Property Value

string

CustomControl

Returns the custom control used to render this control.

public repCustomControl CustomControl { get; }

Property Value

repCustomControl

CustomControlScript

Returns the script expression to render this control in case of a custom control.

public string CustomControlScript { get; }

Property Value

string

Field

Returns the repository field this control is bound to.

public repField Field { get; }

Property Value

repField

Form

Returns the form this control is part of.

public repForm Form { get; }

Property Value

repForm

Height

Returns the height of this control.

public int Height { get; }

Property Value

int

HeightInListView

Returns the height of this control when shown in list view.

public int HeightInListView { get; }

Property Value

int

InFilterForm

Returns a boolean indicating this control is to be shown in the filter form.

public bool InFilterForm { get; }

Property Value

bool

Name

Returns the name of the control.

public string Name { get; }

Property Value

string

Notes

Returns the notes for this control.

public string Notes { get; }

Property Value

string

OnLoadControlScript

Returns the OnLoadControlScript-script expression for custom controls

public string OnLoadControlScript { get; }

Property Value

string

OnUnloadControlScript

Returns the OnUnloadControlScript-script expression for custom controls

public string OnUnloadControlScript { get; }

Property Value

string

Script

Returns the script expression set for this control.

public string Script { get; }

Property Value

string

ScriptedFilterControl

Returns a boolean indicating the custom control used for this control is also to be used to create the filter control instead of the default filter control.

public bool ScriptedFilterControl { get; }

Property Value

bool

SysControlID

Returns the SysControlID as known in the repository.

public int SysControlID { get; }

Property Value

int

SysFieldID

Returns the SysFieldID of the field this control is bound to. Returns 0 if the control is not bound to a field.

public int SysFieldID { get; }

Property Value

int

SysRelationID

Returns the SysRelationID of the relation this control is bound to. Only applicable to 'related item controls'.

public int SysRelationID { get; }

Property Value

int

Width

Returns the width of this control.

public int Width { get; }

Property Value

int

WidthInListView

Returns the width of this control when shown in list view.

public int WidthInListView { get; }

Property Value

int

Methods

Settings(int)

Returns the group specific settings for the specified SysGroupID for this control.

public repControlSettings Settings(int pSysGroupID)

Parameters

pSysGroupID int

The group to get the settings for. Use 0 to get the default settings.

Returns

repControlSettings

The group specific settings.

ViewAllowedInState(int, int)

Returns a boolean indicating the unbound control is visible in a specified state for a specified group.

public bool ViewAllowedInState(int pSysGroupID, int pSysStateID)

Parameters

pSysGroupID int

The SysGroupID to test for.

pSysStateID int

The SysStateID to test for.

Returns

bool

A boolean indicating the control is visible.