cancel
Showing results for 
Search instead for 
Did you mean: 
Reply
srasmussen
Advocate I
Advocate I

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
Responsive Resident
Responsive Resident

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/...

srasmussen
Advocate I
Advocate I

@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

Exclusive LIVE Community Event: Power Apps Copilot Coffee Chat with Copilot Studio Product Team

  It's time for the SECOND Power Apps Copilot Coffee Chat featuring the Copilot Studio product team, which will be held LIVE on April 3, 2024 at 9:30 AM Pacific Daylight Time (PDT).     This is an incredible opportunity to connect with members of the Copilot Studio product team and ask them anything about Copilot Studio. We'll share our special guests with you shortly--but we want to encourage to mark your calendars now because you will not want to miss the conversation.   This live event will give you the unique opportunity to learn more about Copilot Studio plans, where we’ll focus, and get insight into upcoming features. We’re looking forward to hearing from the community, so bring your questions!   TO GET ACCESS TO THIS EXCLUSIVE AMA: Kudo this post to reserve your spot! Reserve your spot now by kudoing this post.  Reservations will be prioritized on when your kudo for the post comes through, so don't wait! Click that "kudo button" today.   Invitations will be sent on April 2nd.Users posting Kudos after April 2nd. at 9AM PDT may not receive an invitation but will be able to view the session online after conclusion of the event. Give your "kudo" today and mark your calendars for April 3rd, 2024 at 9:30 AM PDT and join us for an engaging and informative session!

Tuesday Tip: Unlocking Community Achievements and Earning Badges

TUESDAY TIPS are our way of communicating helpful things we've learned or shared that have helped members of the Community. Whether you're just getting started or you're a seasoned pro, Tuesday Tips will help you know where to go, what to look for, and navigate your way through the ever-growing--and ever-changing--world of the Power Platform Community! We cover basics about the Community, provide a few "insider tips" to make your experience even better, and share best practices gleaned from our most active community members and Super Users.   With so many new Community members joining us each week, we'll also review a few of our "best practices" so you know just "how" the Community works, so make sure to watch the News & Announcements each week for the latest and greatest Tuesday Tips!     THIS WEEK'S TIP: Unlocking Achievements and Earning BadgesAcross the Communities, you'll see badges on users profile that recognize and reward their engagement and contributions. These badges each signify a different achievement--and all of those achievements are available to any Community member! If you're a seasoned pro or just getting started, you too can earn badges for the great work you do. Check out some details on Community badges below--and find out more in the detailed link at the end of the article!       A Diverse Range of Badges to Collect The badges you can earn in the Community cover a wide array of activities, including: Kudos Received: Acknowledges the number of times a user’s post has been appreciated with a “Kudo.”Kudos Given: Highlights the user’s generosity in recognizing others’ contributions.Topics Created: Tracks the number of discussions initiated by a user.Solutions Provided: Celebrates the instances where a user’s response is marked as the correct solution.Reply: Counts the number of times a user has engaged with community discussions.Blog Contributor: Honors those who contribute valuable content and are invited to write for the community blog.       A Community Evolving Together Badges are not only a great way to recognize outstanding contributions of our amazing Community members--they are also a way to continue fostering a collaborative and supportive environment. As you continue to share your knowledge and assist each other these badges serve as a visual representation of your valuable contributions.   Find out more about badges in these Community Support pages in each Community: All About Community Badges - Power Apps CommunityAll About Community Badges - Power Automate CommunityAll About Community Badges - Copilot Studio CommunityAll About Community Badges - Power Pages Community

Tuesday Tips: Powering Up Your Community Profile

TUESDAY TIPS are our way of communicating helpful things we've learned or shared that have helped members of the Community. Whether you're just getting started or you're a seasoned pro, Tuesday Tips will help you know where to go, what to look for, and navigate your way through the ever-growing--and ever-changing--world of the Power Platform Community! We cover basics about the Community, provide a few "insider tips" to make your experience even better, and share best practices gleaned from our most active community members and Super Users.   With so many new Community members joining us each week, we'll also review a few of our "best practices" so you know just "how" the Community works, so make sure to watch the News & Announcements each week for the latest and greatest Tuesday Tips!   This Week's Tip: Power Up Your Profile!  🚀 It's where every Community member gets their start, and it's essential that you keep it updated! Your Community User Profile is how you're able to get messages, post solutions, ask questions--and as you rank up, it's where your badges will appear and how you'll be known when you start blogging in the Community Blog. Your Community User Profile is how the Community knows you--so it's essential that it works the way you need it to! From changing your username to updating contact information, this Knowledge Base Article is your best resource for powering up your profile.     Password Puzzles? No Problem! Find out how to sync your Azure AD password with your community account, ensuring a seamless sign-in. No separate passwords to remember! Job Jumps & Email Swaps Changed jobs? Got a new email? Fear not! You'll find out how to link your shiny new email to your existing community account, keeping your contributions and connections intact. Username Uncertainties Unraveled Picking the perfect username is crucial--and sometimes the original choice you signed up with doesn't fit as well as you may have thought. There's a quick way to request an update here--but remember, your username is your community identity, so choose wisely. "Need Admin Approval" Warning Window? If you see this error message while using the community, don't worry. A simple process will help you get where you need to go. If you still need assistance, find out how to contact your Community Support team. Whatever you're looking for, when it comes to your profile, the Community Account Support Knowledge Base article is your treasure trove of tips as you navigate the nuances of your Community Profile. It’s the ultimate resource for keeping your digital identity in tip-top shape while engaging with the Power Platform Community. So, dive in and power up your profile today!  💪🚀   Community Account Support | Power Apps Community Account Support | Power AutomateCommunity Account Support | Copilot Studio  Community Account Support | Power Pages

Super User of the Month | Chris Piasecki

In our 2nd installment of this new ongoing feature in the Community, we're thrilled to announce that Chris Piasecki is our Super User of the Month for March 2024. If you've been in the Community for a while, we're sure you've seen a comment or marked one of Chris' helpful tips as a solution--he's been a Super User for SEVEN consecutive seasons!       Since authoring his first reply in April 2020 to his most recent achievement organizing the Canadian Power Platform Summit this month, Chris has helped countless Community members with his insights and expertise. In addition to being a Super User, Chris is also a User Group leader, Microsoft MVP, and a featured speaker at the Microsoft Power Platform Conference. His contributions to the new SUIT program, along with his joyous personality and willingness to jump in and help so many members has made Chris a fixture in the Power Platform Community.   When Chris isn't authoring solutions or organizing events, he's actively leading Piasecki Consulting, specializing in solution architecture, integration, DevOps, and more--helping clients discover how to strategize and implement Microsoft's technology platforms. We are grateful for Chris' insightful help in the Community and look forward to even more amazing milestones as he continues to assist so many with his great tips, solutions--always with a smile and a great sense of humor.You can find Chris in the Community and on LinkedIn. Thanks for being such a SUPER user, Chris! 💪🌠

Tuesday Tips: Community Ranks and YOU

TUESDAY TIPS are our way of communicating helpful things we've learned or shared that have helped members of the Community. Whether you're just getting started or you're a seasoned pro, Tuesday Tips will help you know where to go, what to look for, and navigate your way through the ever-growing--and ever-changing--world of the Power Platform Community! We cover basics about the Community, provide a few "insider tips" to make your experience even better, and share best practices gleaned from our most active community members and Super Users.   With so many new Community members joining us each week, we'll also review a few of our "best practices" so you know just "how" the Community works, so make sure to watch the News & Announcements each week for the latest and greatest Tuesday Tips!This Week: Community Ranks--Moving from "Member" to "Community Champion"   Have you ever wondered how your fellow community members ascend the ranks within our community? What sets apart an Advocate from a Helper, or a Solution Sage from a Community Champion? In today’s #TuesdayTip, we’re unveiling the secrets and sharing tips to help YOU elevate your ranking—and why it matters to our vibrant communities. Community ranks serve as a window into a member’s role and activity. They celebrate your accomplishments and reveal whether someone has been actively contributing and assisting others. For instance, a Super User is someone who has been exceptionally helpful and engaged. Some ranks even come with special permissions, especially those related to community management. As you actively participate—whether by creating new topics, providing solutions, or earning kudos—your rank can climb. Each time you achieve a new rank, you’ll receive an email notification. Look out for the icon and rank name displayed next to your username—it’s a badge of honor! Fun fact: Your Community Engagement Team keeps an eye on these ranks, recognizing the most passionate and active community members. So shine brightly with valuable content, and you might just earn well-deserved recognition! Where can you see someone’s rank? When viewing a post, you’ll find a member’s rank to the left of their name.Click on a username to explore their profile, where their rank is prominently displayed. What about the ranks themselves? New members start as New Members, progressing to Regular Visitors, and then Frequent Visitors.Beyond that, we have a categorized system: Kudo Ranks: Earned through kudos (teal icons).Post Ranks: Based on your posts (purple icons).Solution Ranks: Reflecting your solutions (green icons).Combo Ranks: These orange icons combine kudos, solutions, and posts. The top ranks have unique names, making your journey even more exciting! So dive in, collect those kudos, share solutions, and let’s see how high you can rank! 🌟 🚀   Check out the Using the Community boards in each of the communities for more helpful information!  Power Apps, Power Automate, Copilot Studio & Power Pages

Find Out What Makes Super Users So Super

We know many of you visit the Power Platform Communities to ask questions and receive answers. But do you know that many of our best answers and solutions come from Community members who are super active, helping anyone who needs a little help getting unstuck with Business Applications products? We call these dedicated Community members Super Users because they are the real heroes in the Community, willing to jump in whenever they can to help! Maybe you've encountered them yourself and they've solved some of your biggest questions. Have you ever wondered, "Why?"We interviewed several of our Super Users to understand what drives them to help in the Community--and discover the difference it has made in their lives as well! Take a look in our gallery today: What Motivates a Super User? - Power Platform Community (microsoft.com)

Top Solution Authors
Users online (5,204)