Class PmpTabGroupFluentCheckable

Namespace

Hymma.Solidworks.Addins.Fluent

Assembly

Hymma.Solidworks.Addins.Fluent.dll

a checkable group inside a tab inside a property manager page

public class PmpTabGroupFluentCheckable : PmpGroupCheckable, IWrapSolidworksObject<IPropertyManagerPageGroup>, IReleaseSolidworksObject, IPmpTabGroupFluentCheckable, IPmpGroupFluentBase<IPmpTabGroupFluentCheckable>

Inheritance

object

PmpGroup

PmpGroupCheckable

PmpTabGroupFluentCheckable

Implements

IWrapSolidworksObject<IPropertyManagerPageGroup>

IReleaseSolidworksObject

IPmpTabGroupFluentCheckable

IPmpGroupFluentBase<IPmpTabGroupFluentCheckable>

Inherited Members

PmpGroupCheckable.IsChecked

PmpGroupCheckable.Checked

PmpGroupCheckable.UnsubscribeFromEvents()

PmpGroup._options

PmpGroup.Id

PmpGroup.Visible

PmpGroup.Caption

PmpGroup.IsExpanded

PmpGroup.Controls

PmpGroup.SolidworksObject

PmpGroup.AddControl(IPmpControl)

PmpGroup.AddControls(IEnumerable<IPmpControl>)

PmpGroup.BackgroundColor

PmpGroup.Registering

PmpGroup.Displaying

PmpGroup.Expanded

PmpGroup.ReleaseSolidworksObject()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

PmpTabGroupFluentCheckable(string, bool, bool, bool)

default constructor

public PmpTabGroupFluentCheckable(string caption, bool visible = true, bool isChecked = true, bool expanded = true)

Parameters

caption string

visible bool

isChecked bool

expanded bool

Properties

Tab

the tab this group belongs to

public PmpTabFluent Tab { get; }

Property Value

PmpTabFluent

Methods

And()

add extra context to this PmpGroup

public IPmpTabGroupFluentCheckable And()

Returns

IPmpTabGroupFluentCheckable

Color(SysColor)

background color of this group

public IPmpTabGroupFluentCheckable Color(SysColor sysColor)

Parameters

sysColor SysColor

Returns

IPmpTabGroupFluentCheckable

HasTheseControls(IEnumerable<IPmpControl>)

add these controls to the PmpGroup

public IPmpTabGroupFluentCheckable HasTheseControls(IEnumerable<IPmpControl> controls)

Parameters

controls IEnumerable<IPmpControl>

an IEnumerable<T> where T : IPmpControl

Returns

IPmpTabGroupFluentCheckable

HasTheseControls(Func<IEnumerable<IPmpControl>>)

add these controls to the PmpGroup

public IPmpTabGroupFluentCheckable HasTheseControls(Func<IEnumerable<IPmpControl>> controlMaker)

Parameters

controlMaker Func<IEnumerable<IPmpControl>>

function that returns an IEnumerable<T> where T : IPmpControl

Returns

IPmpTabGroupFluentCheckable

IsHidden(bool)

hides this group

public IPmpTabGroupFluentCheckable IsHidden(bool isHidden = true)

Parameters

isHidden bool

Returns

IPmpTabGroupFluentCheckable

OnChecked(EventHandler<bool>)

fires when user check/un-check the gourp check box

public IPmpTabGroupFluentCheckable OnChecked(EventHandler<bool> doThis)

Parameters

doThis EventHandler<bool>

Returns

IPmpTabGroupFluentCheckable

PmpGroupCheckable

OnDisplaying(EventHandler<EventArgs>)

fires when this group is displayed on the screen

public IPmpTabGroupFluentCheckable OnDisplaying(EventHandler<EventArgs> doThis)

Parameters

doThis EventHandler<EventArgs>

Returns

IPmpTabGroupFluentCheckable

OnExpansionChange(Action<PmpGroup, bool>)

event handler for when user expands the group

public IPmpTabGroupFluentCheckable OnExpansionChange(Action<PmpGroup, bool> doThis)

Parameters

doThis Action<PmpGroup, bool>

delegate that accepts a bool as the parameter and returns void. bool parameter will be assigned by solidworks and indicates the expansion state of the group.

Returns

IPmpTabGroupFluentCheckable

SaveGroup()

save all the changes

public IPmpTabFluent SaveGroup()

Returns

IPmpTabFluent

IPmpTabFluent

SetCheckedStatus(bool)

defines whether a chackable group appears in its checked state by default

public IPmpTabGroupFluentCheckable SetCheckedStatus(bool status = true)

Parameters

status bool

Returns

IPmpTabGroupFluentCheckable

IPmpTabGroupFluentCheckable

SetExpansion(bool)

determines if this PmpGroup is expanded or not

public IPmpTabGroupFluentCheckable SetExpansion(bool isExpanded = true)

Parameters

isExpanded bool

Returns

IPmpTabGroupFluentCheckable

That()

add extra context to this PmpGroup

public IPmpTabGroupFluentCheckable That()

Returns

IPmpTabGroupFluentCheckable