Property Manager Pages made suuuuuper easy with SwEx.PMPage Framework

Discussion created by Artem Taturevych on Sep 4, 2018
Latest reply on Oct 13, 2019 by Artem Taturevych

Like • Show 6 Likes6
Comment • 5

Hi,

I want to introduce new free and open source library in the SwEx Framework family in addition to the SwEx.AddIn which was published last week.

SwEx.PMPage library is designed to simplify the way the property manager pages are created and the values are being synchronised with the data model. Framework is used different approach where property manager page is created and bound automatically from the data model.

For more information, API reference and video demonstration of the benefits of the framework follow this link: SwEx.PMPage

Thanks,

Artem

Outcomes

5 Replies

Artem Taturevych Nov 13, 2018 5:55 AM

New 0.4.0 version is release and published on NuGet. New version includes the following enhancements:

Added support for control tags and dependencies
Exposed control interface to access native SOLIDWORKS Property Manager Page Control
Added support for custom icons for controls and property page
Added the ability to add message to property page
Added ability to specify display text for enumeration fields used as items for combo box control
Added the ability to provide custom selection filter for the selection box control
Added the ability to ignore properties from creation property page controls

Check documentation and API reference for more information and example projects.

This is a free and open source library available on GitHub.

This framework uses completely new approach for designing property manager pages. Allowing to develop simple, robust type safe pages in SOLIDWORKS by defining the data model.

For example this is the property page and its behaviour created using the SwEx.PMPage framework for new version of Bounding Cylinder (Round Stock) Add-In

Page icon loaded from the png file added to resources supporting transparency and automatically resized to fit SOLIDWORKS required size.
Custom message displayed in the page
Links to help documentation and what's new page
Standard 'Select Face' icon used for selection box control
Selection box allowing selection of faces and planes
Additional check boxes
Custom images added to controls (loaded from resources and automatically resized to match SOLIDWORKS required sizes)
Additional styles applied to numberbox controls to include units of measure and wheel
Controls enable state is controlled by the value of the check box. State is automatically updated when check box value is changed
Tooltip of the control is displayed when mouse hovers the control

And below is the only code required to create this property page. Note that it is not required to add any controls explicitly or set/get control values. Framework will take care of it and bound of the user selections directly to the defined data model (class object):

[PageOptions(typeof(Resources), nameof(Resources.round_stock_icon),
    swPropertyManagerPageOptions_e.swPropertyManagerOptions_OkayButton |
            swPropertyManagerPageOptions_e.swPropertyManagerOptions_CancelButton
            | swPropertyManagerPageOptions_e.swPropertyManagerOptions_WhatsNew)]
    [Message("Select cylindrical face or plane to generate the round stock", "Stock Feature")]
    [Help("https://www.codestack.net/labs/solidworks/stock-fit-geometry/",
    "https://www.codestack.net/labs/solidworks/stock-fit-geometry/whats-new")]
    [DisplayName("Round Stock")]
    public class RoundStockViewModel
    {
        public enum RoundStepControls_e
        {
            StockStep,
            UseCustomStep,
            CustomStep
        }

        public class StockStepDependencyHandler : DependencyHandler
        {
            protected override void UpdateControlState(IPropertyManagerPageControlEx control, IPropertyManagerPageControlEx[] parents)
            {
                if (parents != null && parents.Length == 1
                    && RoundStepControls_e.UseCustomStep.Equals(parents.First().Tag))
                {
                    var useCustom = (bool)parents.First().GetValue();


                    switch ((RoundStepControls_e)control.Tag)
                    {
                        case RoundStepControls_e.CustomStep:
                            control.Enabled = useCustom;
                            break;


                        case RoundStepControls_e.StockStep:
                            control.Enabled = !useCustom;
                            break;
                    }
                }
                else
                {
                    Debug.Assert(false, "Invalid dependency. This handler should only be applied to rounding step controls");
                }
            }
        }


        public class RoundingOptions
        {
            [Description("Predefined rounding step")]
            [ControlTag(RoundStepControls_e.StockStep)]
            [DependentOn(typeof(StockStepDependencyHandler), RoundStepControls_e.UseCustomStep)]
            [ControlAttribution(typeof(Resources), nameof(Resources.round_step_predefined))]
            public StockSteps_e StockStep { get; set; }


            [DisplayName("Use custom round step")]
            [ControlTag(RoundStepControls_e.UseCustomStep)]
            public bool UseCustomStep { get; set; }


            [Description("Custom rounding step")]
            [NumberBoxOptions(swNumberboxUnitType_e.swNumberBox_Length, 0, 1000, 0.001,
                true, 0.01, 0.0005, swPropMgrPageNumberBoxStyle_e.swPropMgrPageNumberBoxStyle_Thumbwheel)]
            [DependentOn(typeof(StockStepDependencyHandler), RoundStepControls_e.UseCustomStep)]
            [ControlTag(RoundStepControls_e.CustomStep)]
            [ControlAttribution(typeof(Resources), nameof(Resources.round_step_custom))]
            public double CustomStep { get; set; }
        }


        public class ExtraMaterialOptions
        {
            [Description("Add additional material to cylinder diameter")]
            [NumberBoxOptions(swNumberboxUnitType_e.swNumberBox_Length, 0, 1000, 0.001,
                true, 0.01, 0.0005, swPropMgrPageNumberBoxStyle_e.swPropMgrPageNumberBoxStyle_Thumbwheel)]
            [ControlAttribution(swControlBitmapLabelType_e.swBitmapLabel_Diameter)]
            public double AdditionalRadius { get; set; }
        }


        public class ConditionOptions
        {
            [SelectionBox(swSelectType_e.swSelFACES, swSelectType_e.swSelDATUMPLANES)]
            [DisplayName("Reference geometry defining the direction of round stock")]
            [ControlAttribution(swControlBitmapLabelType_e.swBitmapLabel_SelectFace)]
            public object Direction { get; set; }


            [DisplayName("Concentric with cylindrical face")]
            [Description("Specifies if the round stock needs to be concentric with selected cylindrical face")]
            public bool ConcentricWithCylindricalFace { get; set; } = true;


            [DisplayName("Create Solid Body")]
            [Description("Specifies if solid body needs to be created")]
            public bool CreateSolidBody { get; set; } = true;
        }
        
        public ConditionOptions Conditions { get; set; }
        
        public RoundingOptions Rounding { get; set; }


        [DisplayName("Extra Material")]
        public ExtraMaterialOptions ExtraMaterial { get; set; }
    }


    public enum StockSteps_e
    {
        [ComboBoxItemText("0")]
        Step0, //0


        [ComboBoxItemText("1/16")]
        Step1_16,//0.0015875


        [ComboBoxItemText("1/8")]
        Step1_8//0.003175
    }

Actions

Dave Bear @ Artem Taturevych on Nov 13, 2018 6:00 AM
Once again Artem, absolutely brilliant stuff!

You should be commended for your selfless efforts, well done!

Dave.
Like • Show 3 Likes3
Actions

Artem Taturevych Sep 10, 2019 8:12 AM
Hi,

I have published the detailed video tutorial of how to build property manager pages: Tutorial: Creating SOLIDWORKS Add-In from scratch (part 2 - Property Pages) - YouTube . I will publish the Russian version in a week or so.

Thanks,
Artem
Like • Show 4 Likes4
Actions
Artem Taturevych Sep 25, 2019 7:52 AM
New version is released with 4 major enhancements:
- Support for buttons
- Support for tabs
- Support for bitmaps
- Support for INotifyPropertyChanged for the dynamic properties
For example the below data model would add number box, button and bitmap loaded from the resources. The value of number box is updated when button is clicked:

public class DataModel : INotifyPropertyChanged
{
public event PropertyChangedEventHandler PropertyChanged;
  private double m_Val1;
  public double Val1
  {
      get
      {
          return m_Val1;
      }
      set
      {
          m_Val1 = value;
          PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nameof(Val1)));
      }
  }
  public Action Reset => OnResetClick;
  public Image MyBitmap = Resources.SampleBitmap;

  private void OnResetClick()
  {
      Val1 = 10;
  }
}

Below data model will add two text boxes into 2 different tabs

public class DataModel
{
  [Tab]
  public class Tab1DataModel
  {
      public string Text1 { get; set; }
  }

  [Tab]
  public class Tab2DataModel
  {
      public string Text2 { get; set; }
  }

  public Tab1DataModel Tab1 { get;set; }
  public Tab2DataModel Tab2 { get;set; }
}
Like • Show 5 Likes5
Actions
Artem Taturevych Oct 14, 2019 5:14 AM
Russian version of the video has been published to YouTube.
Like • Show 0 Likes0
Actions

Property Manager Pages made suuuuuper easy with SwEx.PMPage Framework

Outcomes

Related Content

Recommended Content

Incoming Links