cancel
Showing results for 
Search instead for 
Did you mean: 
Reply

Ability to add public methods or events to a PCF control

I am trying to build a PCF control that replaces the OOB Multi-select optionset control.  One of the things that I can't figure out is how to add public methods to my control such that a form script is able to interact with my PCF control.  For example, I need to be able to add the following methods (that the OOB control has):

addOption(1234)
removeOption(1234)
clearOptions()
getOptions()

It seems like it should be possible based on the response to a similar question here: https://powerusers.microsoft.com/t5/Power-Apps-Pro-Dev-ISV/Form-designer-setting-additional-methods-... 

 

However, I've created similar methods on my class that implements the `ComponentFramework.StandardControl` but it doesn't appear to work.  Is this possible?  If so, where should I be placing my methods?

9 REPLIES 9
skoofy5
Continued Contributor
Continued Contributor

I just a did test with a dropdown control we have on top of an custom option set control and the 'removeOption' method seems to work. Is it triggering the updateView of your control and is your control being re-rendered?

https://docs.microsoft.com/en-us/powerapps/developer/model-driven-apps/clientapi/reference/controls/...

@skoofy5 - Thanks for the reply!  When I try the following in a form "onLoad" script with my custom PCF I get an error: "TypeError: control.removeOption is not a function"

let control = this._formContext.getControl("mrs_legs"); // My custom PCF control
control.removeOption(123); // Throws the exception: TypeError: control.removeOption is not a function

 

If I change the control back to the default then I don't receive that error.

 

My control is very basic at this point but here it is:

import * as React from "react";
import * as ReactDOM from 'react-dom';
import AdvancedMultiSelectControl, { IAdvancedMultiSelectProps } from "./AdvancedMultiSelectControl";
import { IInputs, IOutputs } from "./generated/ManifestTypes";

interface IAdvancedMultiSelectState extends ComponentFramework.Dictionary {

}

export class AdvancedMultiSelect implements ComponentFramework.StandardControl<IInputs, IOutputs> {
    _container: HTMLDivElement;
    _initialVisible: boolean;
    _initialDisabled: boolean;
    _optionSetMetadata: ComponentFramework.PropertyHelper.FieldPropertyMetadata.OptionSetMetadata;

    constructor() {

    }

    public init(
        context: ComponentFramework.Context<IInputs>,
        notifyOutputChanged: () => void,
        state: IAdvancedMultiSelectState,
        container: HTMLDivElement): void {

        this._container = container;
        this._initialVisible = context.mode.isVisible;
        this._initialDisabled = context.mode.isControlDisabled;
        this._optionSetMetadata = context.parameters.controlProps.attributes!;
    }

    public updateView(context: ComponentFramework.Context<IInputs>): void {
        ReactDOM.render(React.createElement(AdvancedMultiSelectControl,
            {
                values: [],
            } as IAdvancedMultiSelectProps),
            this._container);
    }


    public getOutputs(): IOutputs {
        return {};
    }

    public destroy = (): void => {}

    public clearOptions = () => {
        alert("Clear options");
    }

    public getOptions = () => {
        alert("Get options called");
    }

    public removeOption = (option: number) => {
        alert("Remove option");
    }

    public addOption = (option: number) => {
        alert("addOption");
    }
}

 

Are you able to share the code from your control?  I must just be not understanding something correctly.  Thanks!

DianaBirkelbach
Most Valuable Professional
Most Valuable Professional

Just to get a little more precise @srasmussen .

I don't think that the PCFs have the possibility to define own methods.

On the roadmap is only the definition of custom events, similar to Canvas Components. That was announced for Wave 2, 2021 and hopefuly will be soon available: https://docs.microsoft.com/en-us/power-platform-release-plan/2021wave2/power-apps/code-component-imp....

 

The same as @skoofy5 checked, I could verify too that my ColorfulOptionset PCF does have the standard methods (like .getOptions()), exactly like the other standard methods like .setDisabled() and so on. But these are not methods defined inside the PCF, but methods defined for the base type of your PCF. 

These standard methods can be called from form scripting, and the result are the disabled state, or the options provided through the parameters,
For instance .removeOption(...) will call the updateView of your PCF , where context.parameters.optionsInput.attributes.Options doesn't have that option anymore.

Hope this helps!

 

Kind regards,
Diana
----------
Please click "Accept as Solution" if my post answered your question so that others may find it more quickly. If you found this post helpful consider giving it a "Thumbs Up."

Interestingly from that same article, @DianaBirkelbach 


"For model-driven apps, code components can be created for the simple lookup and Multi-select option set (Choices) type, and properties of these new types can also be added. These are top community requests. Additional framework APIs on the canvas apps will be added, which approaches model-driven app parity."

 

Does that mean support for multiselect isn't ready yet?

DianaBirkelbach
Most Valuable Professional
Most Valuable Professional

Hi @skoofy5 
I think it depends how you read the statement. I understand it just as "we can define these properties and use them".
It is confusing, indeed. Maybe I'm wrong.

In my opinion the lookup and multioptionsets are avaibale only for model-driven apps for now.

Even in model-driven apps, considering lookups there are still a lot of properties we need to get from the platform (like in this blog where all these properties for lookup are unsupported: https://dianabirkelbach.wordpress.com/2021/06/19/lookup-pcf-lets-dive-deeper/). Right now we have only the way to get or chnage the value for the lookup; I suppose there is still a lot to come. So no, it's not ready.

 

But I don't understand the statement above talking about custom methods for PCFs. As I said, could be just my opinion.

 

 

 

Kind regards,
Diana
----------
Please click "Accept as Solution" if my post answered your question so that others may find it more quickly. If you found this post helpful consider giving it a "Thumbs Up."

@DianaBirkelbach - That makes sense about the custom functions. Unfortunately, I'm still not able to take advantage of the OOB methods for a MuliSelectOptionSet (ie "addOption" etc).  Perhaps my manifest isn't setup properly or something?  I'm fairly new to PCF controls so that very well could be the issue. I've pushed my project to a Github repo here: https://github.com/StevenRasmussen/PCF.AdvancedMultiChoice 

 

If you have any further thoughts or can point to a repo with a working example it would be much appreciated.

DianaBirkelbach
Most Valuable Professional
Most Valuable Professional

The manifest is looking good, @srasmussen .

If the manifest would be the problem, you wouldn't be able to load the component on the form.

Maybe is really a bug with the MultiOptionSet ? I don't have one to try it out right now.
But you could try to register the sdk example for MultiOptionSet PCF: https://docs.microsoft.com/en-us/powerapps/developer/component-framework/sample-controls/multi-selec... and check there if the methods are available.

Kind regards,
Diana
----------
Please click "Accept as Solution" if my post answered your question so that others may find it more quickly. If you found this post helpful consider giving it a "Thumbs Up."

@DianaBirkelbach - Thanks!  For some reason I missed that documentation.  I'll give it a try and post results here.

@DianaBirkelbach - Just deployed and tested the example PCF control and it unfortunately has the same problem 😞  So it appears that this is a genuine bug with the MultiSelectOptionSet control.  Do you have any ideas on how to report this to MS?  Do they monitor these forums at all?

Helpful resources

Announcements

Community will be READ ONLY July 16th, 5p PDT -July 22nd

Dear Community Members,   We'd like to let you know of an upcoming change to the community platform: starting July 16th, the platform will transition to a READ ONLY mode until July 22nd.   During this period, members will not be able to Kudo, Comment, or Reply to any posts.   On July 22nd, please be on the lookout for a message sent to the email address registered on your community profile. This email is crucial as it will contain your unique code and link to register for the new platform encompassing all of the communities.   What to Expect in the New Community: A more unified experience where all products, including Power Apps, Power Automate, Copilot Studio, and Power Pages, will be accessible from one community.Community Blogs that you can syndicate and link to for automatic updates. We appreciate your understanding and cooperation during this transition. Stay tuned for the exciting new features and a seamless community experience ahead!

Summer of Solutions | Week 4 Results | Winners will be posted on July 24th

We are excited to announce the Summer of Solutions Challenge!   This challenge is kicking off on Monday, June 17th and will run for (4) weeks.  The challenge is open to all Power Platform (Power Apps, Power Automate, Copilot Studio & Power Pages) community members. We invite you to participate in a quest to provide solutions in the Forums to as many questions as you can. Answers can be provided in all the communities.    Entry Period: This Challenge will consist of four weekly Entry Periods as follows (each an “Entry Period”)   - 12:00 a.m. PT on June 17, 2024 – 11:59 p.m. PT on June 23, 2024 - 12:00 a.m. PT on June 24, 2024 – 11:59 p.m. PT on June 30, 2024 - 12:00 a.m. PT on July 1, 2024 – 11:59 p.m. PT on July 7, 2024 - 12:00 a.m. PT on July 8, 2024 – 11:59 p.m. PT on July 14, 2024   Entries will be eligible for the Entry Period in which they are received and will not carryover to subsequent weekly entry periods.  You must enter into each weekly Entry Period separately.   How to Enter: We invite you to participate in a quest to provide "Accepted Solutions" to as many questions as you can. Answers can be provided in all the communities. Users must provide a solution which can be an “Accepted Solution” in the Forums in all of the communities and there are no limits to the number of “Accepted Solutions” that a member can provide for entries in this challenge, but each entry must be substantially unique and different.    Winner Selection and Prizes: At the end of each week, we will list the top ten (10) Community users which will consist of: 5 Community Members & 5 Super Users and they will advance to the final drawing. We will post each week in the News & Announcements the top 10 Solution providers.  At the end of the challenge, we will add all of the top 10 weekly names and enter them into a random drawing.  Then we will randomly select ten (10) winners (5 Community Members & 5 Super Users) from among all eligible entrants received across all weekly Entry Periods to receive the prize listed below. If a winner declines, we will draw again at random for the next winner.  A user will only be able to win once overall. If they are drawn multiple times, another user will be drawn at random.  Individuals will be contacted before the announcement with the opportunity to claim or deny the prize.  Once all of the winners have been notified, we will post in the News & Announcements of each community with the list of winners.   Each winner will receive one (1) Pass to the Power Platform Conference in Las Vegas, Sep. 18-20, 2024 ($1800 value). NOTE: Prize is for conference attendance only and any other costs such as airfare, lodging, transportation, and food are the sole responsibility of the winner. Tickets are not transferable to any other party or to next year’s event.   ** PLEASE SEE THE ATTACHED RULES for this CHALLENGE**   Week 1 Results: Congratulations to the Week 1 qualifiers, you are being entered in the random drawing that will take place at the end of the challenge. Community MembersNumber of SolutionsSuper UsersNumber of Solutions @anandm08  23 @WarrenBelz  31 @DBO_DV  10 @Amik  19 AmínAA 6 @mmbr1606  12 @rzuber  4 @happyume  7 @Giraldoj  3@ANB 6 (tie)   @SpongYe  6 (tie)     Week 2 Results: Congratulations to the Week 2 qualifiers, you are being entered in the random drawing that will take place at the end of the challenge. Community MembersSolutionsSuper UsersSolutions @anandm08  10@WarrenBelz 25 @DBO_DV  6@mmbr1606 14 @AmínAA 4 @Amik  12 @royg  3 @ANB  10 @AllanDeCastro  2 @SunilPashikanti  5 @Michaelfp  2 @FLMike  5 @eduardo_izzo  2   Meekou 2   @rzuber  2   @Velegandla  2     @PowerPlatform-P  2   @Micaiah  2     Week 3 Results: Congratulations to the Week 3 qualifiers, you are being entered in the random drawing that will take place at the end of the challenge.   Week 3:Community MembersSolutionsSuper UsersSolutionsPower Apps anandm0861WarrenBelz86DBO_DV25Amik66Michaelfp13mmbr160647Giraldoj13FLMike31AmínAA13SpongYe27     Week 4 Results: Congratulations to the Week 4 qualifiers, you are being entered in the random drawing that will take place at the end of the challenge.   Week 4:Community MembersSolutionsSuper UsersSolutionsPower Apps DBO-DV21WarranBelz26Giraldoj7mmbr160618Muzammmil_0695067Amik14samfawzi_acml6FLMike12tzuber6ANB8   SunilPashikanti8

Check Out | 2024 Release Wave 2 Plans for Microsoft Dynamics 365 and Microsoft Power Platform

On July 16, 2024, we published the 2024 release wave 2 plans for Microsoft Dynamics 365 and Microsoft Power Platform. These plans are a compilation of the new capabilities planned to be released between October 2024 to March 2025. This release introduces a wealth of new features designed to enhance customer understanding and improve overall user experience, showcasing our dedication to driving digital transformation for our customers and partners.    The upcoming wave is centered around utilizing advanced AI and Microsoft Copilot technologies to enhance user productivity and streamline operations across diverse business applications. These enhancements include intelligent automation, AI-powered insights, and immersive user experiences that are designed to break down barriers between data, insights, and individuals. Watch a summary of the release highlights.    Discover the latest features that empower organizations to operate more efficiently and adaptively. From AI-driven sales insights and customer service enhancements to predictive analytics in supply chain management and autonomous financial processes, the new capabilities enable businesses to proactively address challenges and capitalize on opportunities.    

Updates to Transitions in the Power Platform Communities

We're embarking on a journey to enhance your experience by transitioning to a new community platform. Our team has been diligently working to create a fresh community site, leveraging the very Dynamics 365 and Power Platform tools our community advocates for.  We started this journey with transitioning Copilot Studio forums and blogs in June. The move marks the beginning of a new chapter, and we're eager for you to be a part of it. The rest of the Power Platform product sites will be moving over this summer.   Stay tuned for more updates as we get closer to the launch. We can't wait to welcome you to our new community space, designed with you in mind. Let's connect, learn, and grow together.   Here's to new beginnings and endless possibilities!   If you have any questions, observations or concerns throughout this process please go to https://aka.ms/PPCommSupport.   To stay up to date on the latest details of this migration and other important Community updates subscribe to our News and Announcements forums: Copilot Studio, Power Apps, Power Automate, Power Pages

Users online (1,299)