Interface IPmpUiModelFluent

Namespace

Hymma.Solidworks.Addins.Fluent

Assembly

Hymma.Solidworks.Addins.Fluent.dll

create a new property manager page UI which hosts a number of controls

public interface IPmpUiModelFluent

Methods

AddCheckableGroup(string)

Add a checkable group to this property manager page

IPmpGroupFluentCheckable AddCheckableGroup(string caption)

Parameters

caption string

Returns

IPmpGroupFluentCheckable

AddGroup(string)

Add a group that hosts controls in a property manager page

IPmpGroupFluent AddGroup(string caption)

Parameters

caption string

caption of the group as appears in solidworks

Returns

IPmpGroupFluent

AddMenuPopUpItem(PopUpMenuItem)

Adds a menu item to the pop-up menu for this PropertyManager page. that appears in the right mouse menu button while the property manager page is displayed

IPmpUiModelFluent AddMenuPopUpItem(PopUpMenuItem item)

Parameters

item PopUpMenuItem

Returns

IPmpUiModelFluent

AddTab(PmpTab)

adds a tab to this property manager page

IPmpUiModelFluent AddTab(PmpTab tab)

Parameters

tab PmpTab

the tab to add to this property manager page

Returns

IPmpUiModelFluent

AddTab(string, Bitmap)

Add a tab to this property manager page

IPmpTabFluent AddTab(string caption, Bitmap icon = null)

Parameters

caption string

caption that appears on the tab

icon Bitmap

The Bitmap argument allows you to place a bitmap before the text on the tab
Any portions of the bitmap that are RGB(255,255,255) will be transparent, letting the tab background show through. this will be resized to 16x18 pixels

Returns

IPmpTabFluent

AddTab<T>()

adds a tab to this property manager page

IPmpUiModelFluent AddTab<T>() where T : PmpTab, new()

Returns

IPmpUiModelFluent

IPmpUiModelFluent

Type Parameters

T

Remarks

use this method to share a tab between different property manager pages

AddTab<T>(Action<T>)

creates a tab to this property manager page and configures it before adding it

IPmpUiModelFluent AddTab<T>(Action<T> Config) where T : PmpTab, new()

Parameters

Config Action<T>

Returns

IPmpUiModelFluent

IPmpUiModelFluent

Type Parameters

T

Remarks

use this method to share a configured tab between different property manager pages

OnAfterActivation(EventHandler<EventArgs>)

action to take after the property manager page is activated

IPmpUiModelFluent OnAfterActivation(EventHandler<EventArgs> action)

Parameters

action EventHandler<EventArgs>

Returns

IPmpUiModelFluent

OnAfterClose(EventHandler<PmpCloseEventArgs>)

define void() to invoke after the property manager page is closed

IPmpUiModelFluent OnAfterClose(EventHandler<PmpCloseEventArgs> doThis)

Parameters

doThis EventHandler<PmpCloseEventArgs>

void to invoke

Returns

IPmpUiModelFluent

OnClosing(EventHandler<PmpCloseEventArgs>)

Action to invoke while the property manger page is closing

IPmpUiModelFluent OnClosing(EventHandler<PmpCloseEventArgs> doThis)

Parameters

doThis EventHandler<PmpCloseEventArgs>

Returns

IPmpUiModelFluent

OnKeyStroke(EventHandler<PmpKeyStrokeEventArgs>)

Processes a keystroke that occurred on this PropertyManager page

IPmpUiModelFluent OnKeyStroke(EventHandler<PmpKeyStrokeEventArgs> doThis)

Parameters

doThis EventHandler<PmpKeyStrokeEventArgs>

Action that takes two params, first one is the sender which would be the PmpUiModel and second one is the event argument for this keystroke

Returns

IPmpUiModelFluent

Remarks

WithPmpOptions(PmpOptions) should have the HandleKeystrokes for this action to work

SavePropertyManagerPage(out PropertyManagerPageX64)

builds this property manager page and adds it to the AddinUserInterface
use the PropertyManagerPageX64.Show() method in a AddinCommand callback function so users of your addin can actually see the property manger page once they clicked on a button

IAddinModelBuilder SavePropertyManagerPage(out PropertyManagerPageX64 propertyManagerPage)

Parameters

propertyManagerPage PropertyManagerPageX64

Returns

IAddinModelBuilder

WithCursorStyle(PmpCursorStyles)

Sets the cursor after a selection is made in the SOLIDWORKS graphics area.

IPmpUiModelFluent WithCursorStyle(PmpCursorStyles cursorStyles)

Parameters

cursorStyles PmpCursorStyles

Returns

IPmpUiModelFluent

WithIconInTitle(Bitmap)

The recommended size for bitmaps is a square from 18- to 22-cells wide.

IPmpUiModelFluent WithIconInTitle(Bitmap icon)

Parameters

icon Bitmap

Returns

IPmpUiModelFluent

Remarks

The recommended size for bitmaps is a square from 18- to 22-cells wide. However, the bitmap can be any size, as long as it fits on the title bar. The bitmap appears transparent by mapping any white(RGB(255,255,255)) cells to the current PropertyManager page title bar background color.Remember the special use of this color as you design your bitmap.

WithMessage(string, string, swPropertyManagerPageMessageVisibility, swPropertyManagerPageMessageExpanded)

Sets the message in this PropertyManager page.

IPmpUiModelFluent WithMessage(string caption, string message, swPropertyManagerPageMessageVisibility messageVisibility, swPropertyManagerPageMessageExpanded pageMessageExpanded)

Parameters

caption string

message string

messageVisibility swPropertyManagerPageMessageVisibility

pageMessageExpanded swPropertyManagerPageMessageExpanded

Returns

IPmpUiModelFluent

WithPmpOptions(PmpOptions)

bitwise option as defined in PmpOptions default has okay, cancel, push-pin buttons and page build is disabled during handlers

IPmpUiModelFluent WithPmpOptions(PmpOptions options)

Parameters

options PmpOptions

Returns

IPmpUiModelFluent