Things I learned building my first PCF control

Help UKRAINE ! Your action matters! Donate to support Ukrainian Army! Donate to charity funds! Organize/join street protests in your city to support Ukraine and condemn Russian aggression! Expose and report Russian disinformation! #StandWithUkraine

In April Microsoft made PowerApps Control Framework available for public preview. It was great news for me as a developer. But unfortunately, I wasn’t able to start playing with it back then. So week ago when I had some spare time I decided to check what this framework can offer.

Update from August 8, 2019 Version 1.0.0 finally here with PDF Support (see demo below).


My idea was simple - let’s build gallery control with fullscreen preview of the image and related note information. I built it some time ago as webresource and I thought that build it in PCF would be an easy task. And obviously, I was wrong. But let’s start from the beginning.

The first thing that I need to retrieve was entity name and record id. Well, I thought it should be easy and MS should provide me with some tools do to so. Nope. They don’t. So I start googling. And found this article by Nishant Rana. In his control he uses Xrm.Page to get it. Easy and obvious. But after further inspection, I found that context object contains a property called page. And in that property, you can find both entityid and entityname. Also, you can find appId there.

Context Object

As for now if you try to access page property of context you will get an error in typescript because Microsoft didn’t include it in interface for context. I don’t know how supported this method is, so you will use it on your own risk.

First problem solved. Getting annotation was a pretty easy task as Microsoft allowed us to use webApi in the same manner as on form. Then some styling using w3.css library and some testing locally. Everything works fine and opens in fullscreen. Now I was ready to deploy it to the system and check how it looks. So I packaged a solution and imported it to the system. Then added it to the field as a control. Refreshed the form and checked what we have there.

Gallery Preview

On the first look, everything was fine. But after I clicked on the image to view it in full size I found 2 issues. First of all, it wasn’t open in full screen. It only takes the space of the body of the form. The second issue was an image that I used to show info icon doesn’t load (image below). This one I was able to solve, but the first one remains - for some reason my modal can take just the body space on the form and not the full screen. I tried again and again and eventually wasn’t able to do anything with it. So, if anybody who reads this can tell me how to do it I will be very grateful.

Info Image doesn't load

Regarding the issue with the image that was not loaded. Everything works fine when I tried to debug my code and run it locally. After some investigation, I found a solution in the MS article about one of their sample components. The solution was to use getResource function of resource object from context. Quote from MS: “getResource - Gets a CSS, HTML or img resource defined in the component manifest”. It has 3 parameters - id of the resource, success callback and error callback. The result will be returned as base64 string. And when I tried to use it in debug mode it failed. It constantly returned to me undefined object. I spent a long time thinking about what I was doing wrong. And guess what? I have done everything correctly. For some reason, it doesn’t work locally. When I deployed my solution it works perfectly. So, I don’t know if this is a bug or what, but just be aware of it when you test your code locally. You can see a gallery with the correctly loaded image below.

Info Image loaded succesfully

You can check my final result (opening image and showing info from related note - title and note text) in the video below.

That’s it. Thank you for reading this post. I hope you find useful information for yourself and avoid my mistakes when you will build your own component. Regarding my component - you can find it in my Github repository via this link. Work is still in progress as I hope that I will find a way to make it full screen. Also, I have plans to rebuild UI and make it more friendly.