cancel
Showing results for 
Search instead for 
Did you mean: 
Reply
Polmon
Regular Visitor

How to clear the bound value of a lookup PCF

I've created my own Lookup PCF for my model driven app; it's quite a complicated control that gives the user a load of different options for populating the control, and the control works perfectly for setting a value however I cannot find a way to clear the value once it has been set (the equivalent of clicking the X next to the value in a normal OOB lookup control).

 

Looking at the sample PCF for a lookup (LookupSimpleControl), it passes in a function to set the value of the local property, which is then returned by the getOutputs(), using the value {} as ComponentFramework.LookupValue, as detailed below:

 

Global Variables used in the sample control:

// Used to store necessary data for a single lookup entity selected during runtime
private _selectedItem1: ComponentFramework.LookupValue;
private _selectedItem2: ComponentFramework.LookupValue;

// Used to track which lookup property is being updated
private _updateSelected1 = false;


Where the event is bound and the variable value is set

lookupObjectsButton1.onclick = this.performLookupObjects.bind(this, this._entityType1, this._defaultViewId1, (value, update = true) => {
this._selectedItem1 = value;
this._updateSelected1 = update;
});


 

The method setting (and clearing) the value:

private performLookupObjects(entityType: string, viewId: string, setSelected: (value: ComponentFramework.LookupValue, update?: boolean) => void): void {
// Used cached values from lookup parameter to set options for lookupObjects API
const lookupOptions = {
defaultEntityType: entityType,
defaultViewId: viewId,
allowMultiSelect: false,
entityTypes: [entityType],
viewIds: [viewId]
};

this._context.utils.lookupObjects(lookupOptions).then((success) => {
if (success && success.length > 0) {
// Cache the necessary information for the newly selected entity lookup
const selectedReference = success[0];

const selectedLookupValue: ComponentFramework.LookupValue = {
id: selectedReference.id,
name: selectedReference.name,
entityType: selectedReference.entityType
};

// Update the primary or secondary lookup property
setSelected(selectedLookupValue);

// Trigger a control update
this._notifyOutputChanged();
} else {
setSelected({} as ComponentFramework.LookupValue);
}
}, (error) => {
console.log(error);
});
}


getOutputs method:

public getOutputs(): IOutputs {
// Send the updated selected lookup item back to the ComponentFramework, based on the currently selected item
return this._updateSelected1 ? { controlValue: [this._selectedItem1] } : { controlValue1: [this._selectedItem2] };
}


How the properties are registered in the ControlManifest.Input.xml file:

<property name="controlValue" display-name-key="controlValue_Display_Key" description-key="controlValue_Desc_Key" of-type="Lookup.Simple" usage="bound" required="true" />
<property name="controlValue1" display-name-key="controlValue_Display_Key1" description-key="controlValue_Desc_Key1" of-type="Lookup.Simple" usage="bound" required="true" />


This is essentially the same way my control works, except I'm not using the lookupObjects method, and have a button to clear the value.

 

My global variable:

private _selectedItem: ComponentFramework.LookupValue;


My event binding:

this._buttonClearField.onclick = this.onClearClick.bind(this, (value) => {
this._selectedItem = value;
});


My click event which clears the value:

private async onClearClick(setSelected: (value: ComponentFramework.LookupValue) => void) {
// Clear the lookup property
setSelected({} as ComponentFramework.LookupValue);
}


My getOutputs method:

public getOutputs(): IOutputs
{
return { boundField: [this._selectedItem] };
}


My control property:

<property name="boundField" display-name-key="Bound Field" description-key="The field the control is bound to" of-type="Lookup.Simple" usage="bound" required="true" />


This looks the same to me. After the clear event runs, the _selectedItem property is cleared, but the context.parameters.boundField value doesn't seem to get updated, and when the record on the form is saved, the field value isn't cleared. I've tried calling notifyOutputChanged, manually clearing the value from context.parameters.boundField, but the field value just doesn't get cleared.

 

I haven't managed to get the sample PCF working yet to see if that actually works, that's my next step (I'm just setting up and env and app I can use for that.

 

Is there anything in the above that looks wrong? Has anyone else encountered this issue, or managed to clear a bound lookup value from their PCF? Please help, this has been driving me nuts for a few weeks now.

1 ACCEPTED SOLUTION

Accepted Solutions
DianaBirkelbach
Most Valuable Professional
Most Valuable Professional

Hi @Polmon , 

 

You're right, you need to set the value to undefined.
Of course you need to change the onClearClick, to set the value to undefined (not to {}).
The notifyOutputChanged need to be called too.

Can you please check with the debugger or logging that the value passed through getOutputs is undefined...
Yes, I've just checked, and I can clear the value of a lookup that way.

I've changed the first answer with this details, just to have them all together.

 

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

View solution in original post

5 REPLIES 5
Polmon
Regular Visitor

I've had a chance to try out the sample control now, and the cancel function (where it uses the setSelected function to return {} as ComponentFramework.LookupValue) doesn't do anything unfortunately, it just cancels the lookup dialog without returning a value to update the bound property. Still no idea how to clear the bound property of a lookup PCF unfortunately.

DianaBirkelbach
Most Valuable Professional
Most Valuable Professional

Hi @Polmon , 

 

try to change the getOutputs to something like this

 

 

public getOutputs(): IOutputs
{
return { boundField: this._selectedItem ? [this._selectedItem] : undefined };
}

 

 

Using the "return {}" will not change any property, you need to pass undefined in order to notify the framework that your value was changed/removed.

Of course you need to change the onClearClick to set the value on undefined

 

private async onClearClick(setSelected: (value: ComponentFramework.LookupValue) => void) {
// Clear the lookup property
setSelected(undefined);
}

 

Inside the "setSelected" you need to call the 

this._notifyOutputChanged()

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

Hi Diana, I've just had a go at that; I can't use null as boundField is ComponentFramework.LookupValue[] | undefined, so I tried using undefined instead as follows:

public getOutputs(): IOutputs
{
return { boundField: this._selectedItem ? [this._selectedItem] : undefined};
}

 

Unfortunately, this didn't work, clearing the field doesn't show the form as unsaved and saving subsequently doesn't clear the field. I also tried using {} as ComponentFramework.LookupValue in getOutputs too as shown below, but that doesn't work either.

public getOutputs(): IOutputs
{
return { boundField: this._selectedItem ? [this._selectedItem] : {} as ComponentFramework.LookupValue};
}

 

I tried dropping notifyOutputChanged in to my clear button event too, but that didn't make a difference either.

 

Have you managed to get this working?

DianaBirkelbach
Most Valuable Professional
Most Valuable Professional

Hi @Polmon , 

 

You're right, you need to set the value to undefined.
Of course you need to change the onClearClick, to set the value to undefined (not to {}).
The notifyOutputChanged need to be called too.

Can you please check with the debugger or logging that the value passed through getOutputs is undefined...
Yes, I've just checked, and I can clear the value of a lookup that way.

I've changed the first answer with this details, just to have them all together.

 

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

Yes! That was it. I needed to change the declaration of the value everywhere it was used, but it's working now.

 

For the benefit of anyone else, I'll detail below the working setup.

 

The variable that's returned:

private _selectedItem: ComponentFramework.LookupValue | undefined;

 

The binding for the button click event (the _notifyOutputChanged reference is set to the parameter passed into the init function):

this._buttonClearField.onclick = this.onClearClick.bind(this, (value) => {
    this._selectedItem = value;
    this._notifyOutputChanged();
});

 

 The clear button click implementation: 

private async onClearClick(setSelected: (value: ComponentFramework.LookupValue | undefined) => void) {
    // Clear the lookup property
    setSelected(undefined);
}

 

In getOutputs, just pass back the value or undefined (I could probably just pass back _selectedItem here without the check):

public getOutputs(): IOutputs
{
    return { boundField: this._selectedItem ? [this._selectedItem] : undefined };
}

 

And that's it, the value is cleared on click now. Thank you @DianaBirkelbach!

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! 💪🌠

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)

March User Group Update: New Groups and Upcoming Events!

  Welcome to this month’s celebration of our Community User Groups and exciting User Group events. We’re thrilled to introduce some brand-new user groups that have recently joined our vibrant community. Plus, we’ve got a lineup of engaging events you won’t want to miss. Let’s jump right in: New User Groups   Sacramento Power Platform GroupANZ Power Platform COE User GroupPower Platform MongoliaPower Platform User Group OmanPower Platform User Group Delta StateMid Michigan Power Platform Upcoming Events  DUG4MFG - Quarterly Meetup - Microsoft Demand PlanningDate: 19 Mar 2024 | 10:30 AM to 12:30 PM Central America Standard TimeDescription: Dive into the world of manufacturing with a focus on Demand Planning. Learn from industry experts and share your insights. Dynamics User Group HoustonDate: 07 Mar 2024 | 11:00 AM to 01:00 PM Central America Standard TimeDescription: Houston, get ready for an immersive session on Dynamics 365 and the Power Platform. Connect with fellow professionals and expand your knowledge. Reading Dynamics 365 & Power Platform User Group (Q1)Date: 05 Mar 2024 | 06:00 PM to 09:00 PM GMT Standard TimeDescription: Join our virtual meetup for insightful discussions, demos, and community updates. Let’s kick off Q1 with a bang! Leaders, Create Your Events!    Leaders of existing User Groups, don’t forget to create your events within the Community platform. By doing so, you’ll enable us to share them in future posts and newsletters. Let’s spread the word and make these gatherings even more impactful! Stay tuned for more updates, inspiring stories, and collaborative opportunities from and for our Community User Groups.   P.S. Have an event or success story to share? Reach out to us – we’d love to feature you!

Users online (5,099)