Class PmpGroup

Namespace

Hymma.Solidworks.Addins

Assembly

Hymma.Solidworks.Addins.dll

a wrapper for solidworks property manager page groups

public class PmpGroup : IWrapSolidworksObject<IPropertyManagerPageGroup>, IReleaseSolidworksObject

Inheritance

object

PmpGroup

Implements

IWrapSolidworksObject<IPropertyManagerPageGroup>

IReleaseSolidworksObject

Derived

PmpGroupFluent

PmpTabGroupFluent

PmpGroupCheckable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

PmpGroup(string, bool, bool)

construct a property manage page group to host numerous IPmpControl

public PmpGroup(string caption = "Group", bool expanded = true, bool visible = true)

Parameters

caption string

text that appears next to a group box

expanded bool

if set true group box will appear expanded by default

visible bool

if set to false group box will be hidden by default

PmpGroup(string, List<IPmpControl>, bool, bool)

construct a property manager page group to host numerous IPmpControl

public PmpGroup(string Caption, List<IPmpControl> Controls, bool expanded = true, bool visible = true)

Parameters

Caption string

text that appears next to a group box

Controls List<IPmpControl>

list of controls to add to this group

expanded bool

if set true group box will appear expanded by default

visible bool

if set to false group box will be hidden by default

Fields

_options

this is used at registering stage only

protected swAddGroupBoxOptions_e _options

Field Value

swAddGroupBoxOptions_e

Properties

BackgroundColor

Gets or sets the background color of this PropertyManager group box.

public SysColor BackgroundColor { get; set; }

Property Value

SysColor

Caption

caption

public string Caption { get; set; }

Property Value

string

Controls

a list of solidworks controllers

public List<IPmpControl> Controls { get; }

Property Value

List<IPmpControl>

Id

identifier for this group box in Property manager page

public int Id { get; }

Property Value

int

IsExpanded

determines the expand state of this group box

public bool IsExpanded { get; set; }

Property Value

bool

SolidworksObject

gets native solidworks object

public IPropertyManagerPageGroup SolidworksObject { get; }

Property Value

IPropertyManagerPageGroup

Visible

Gets or sets the group box visibility state.

public bool Visible { get; set; }

Property Value

bool

Methods

AddControl(IPmpControl)

Registers a control to the Controls and solidworks UI

public void AddControl(IPmpControl control)

Parameters

control IPmpControl

AddControls(IEnumerable<IPmpControl>)

adds a list of controls to the Controls

public void AddControls(IEnumerable<IPmpControl> controls)

Parameters

controls IEnumerable<IPmpControl>

ReleaseSolidworksObject()

reease solidowrks object

public void ReleaseSolidworksObject()

UnsubscribeFromEvents()

Unsusbcribe all event handlers from events

public virtual void UnsubscribeFromEvents()

Events

Displaying

an event that gets called right before this pmpGroup is displayed

public event EventHandler<EventArgs> Displaying

Event Type

EventHandler<EventArgs>

Expanded

method to invoke when user expands a group
this delegate requires a bool variable to indicate the IsExpanded status of the group

public event EventHandler<bool> Expanded

Event Type

EventHandler<bool>

Registering

invoked once this group is registers into solidworks

public event EventHandler<EventArgs> Registering

Event Type

EventHandler<EventArgs>