So recently I wanted to add a Fixed image behind a ScrollView in Xamarin Forms. Furthermore when the ScrollView is scrolling the background image shouldn’t scroll along with it, and background image should stay fixed while the content is scrolling.
So the obvious solution would be to lay down a RelativeLayout and top of that Image, and then a ScrollView with Transparent background.
But I wanted…
but instead of laying out all those layouts and multiple controls, I wanted to achieve this right from one Control, by customizing the ScrollView accordingly.
So I got to into Coding…
So I created a Custom ScrollView control in PCL project and added the Custom Renderers for each platform iOS and Android. Although I got it working with ease in on Android by setting the Image as the Background drawable for the ScrollView, I was having some struggle with iOS.
trouble with iOS UIScrollView…
So the Xamarin Forms ScrollView’s native iOS mapped control is the UIScrollView. So I tried adding the a UIImageView to the UIScrollView from the custom renderer hoping it should get the job done according to theory.
but the background was panning across the Content size. And it started scrolling alone with the Content.
So let me walk you through what I tried and what actually worked… 🙂
1. Adding the UIImageView as a SubView
So as per the obvious solution I added the UIImage into a UIImageView and added it into the UIScrollView as a SubView as shown below. Also you may have noticed how I have called SendSubviewToBack method to place the UIImageView behind the UIScrollView.
And this was the result as you can see below..
As you can see the UIImageView takes up the Height of the UIScrollView Content, not the UIScrollView actual Height, thereby resulting of the UIImageView spanning across the whole Content size. :O
2. Resizing the UIImage and adding the UIImageView as a SubView
Then I thought what if I resized the Image to the actual Height and Width of the UIScrollView and added as a Subview as show below.
Now in an iOS Custom Renderer we can not access the UIScrollView’s Bounds or Frame right from the OnElementChanged method, we need to override the Draw() method, which provides the Height and Width since it’s actually being drawn on the Parent view.
So as you can see I have resized the UIImage and added it to the UIScrollView thought a UIImageView holder.
Look at the results…
Well the Background Image has been resized but the Background View still scrolls with the Content of UIScrollView. 😦
3. How about InsertSubview() ?
There are couple of methods for Adding a SubView to a View, the most common used one is the AddSubView() method which is also an alias for Add().
Then there also another method call we could use, InsertSubview(). In theory it does the same thing as AddSubView() but in a different manner where you could define a View index, in terms of which index the View should be added to in the array of sub-views in the given View.
So instead of this,
Let’s call the below, as you can see I’m placing our UIImageView at the very bottom of the SubViews stack by giving index 0 value.
Oh well what did you expect! Same result as before. 😦
4. How about InsertSubviewBelow() ?
So this method is also somewhat similar to above, where as this allows you to straightaway as a Subview, and define underneath which SubView you need to add your View in the stack. 😀
So I tried this as well. By the “this” reference I’m referring to the UIScrollView as the sibling and to tell the layout engine to place the UIImageView below the UIScrollView. 🙂
But unfortunately the results was the same… 😦
5. What about directly setting the Background?
Frustrated with trying to add SubViews approach, I thought of directly setting the Background property of UIScrollView, specifically set the UIImage directly to the BackgroundColor Property of UIScrollView.
Well there’s no way we could set the BackgroundColor property from the Draw() method override, hence the canvas is already drawn. So we need to set it before its being drawn.
So let’s move back to the OnElementChanged method and set the BackgroundColor.
Since there’s no availability of the Height and Width values within the OnElementChanged event firing, for now we’ll just directly set the UIImage to BackgroundColor without resizing.
Oh well, look at the results. It also fills up the whole Content area, without just setting the “background” on UIScrollView.
5. What about directly setting the Background with resized UIImage?
Alright now let’s get a bit serious and retry the above approach properly, by accessing the Height and Width of the UIScrollView and resizing the UIImage accordingly.
So to do this we need to tap into the place where the Height and Width first gets allocated before the Draw method. That’s by subscribing to the OnPropertyChanged() as shown below.
So inside the OnPropertyChanged() event we are waiting till the Width and Height properties are available, as you can see we are looking for the PropertyName in the event args. Then we resize the UIImage according to the retrieved Height and Width and values of UIScrollView and set the UIImage to the Background.
Now as you can see, the Background Image gets resized to the exact size of UIScrollView but the Background is still scrolling with the content. And if you notice closely, you can see the Background has repeated the Image, this is because of the UIColor.FromPatternImage() where as the UIImage gets repeated to fill the whole canvas. This means that the Background still gets spread across the whole Content area of the UIScrollView.
then I witnessed something strange….
What actually worked… (strangely though)
So meanwhile playing around with different override methods and properties, at some point….
I accidentally left the Draw() method overridden in my Custom Renderer as shown below, and moved the setting of the UIScrollView Background to the OnPropertyChanged event like I did in the previous step.
As you can see in my above code, I have just overriden the Draw() event and left it just as it is, without writing any code inside the method.
And behold! 😀 IT WORKED! 😀
TADAA! 😀 as you can see we have successfully got it to work, a fixed background image in UIScrollView. 😉
Although this does not make any sense, how could the Background of the UIScrollView prevents itself from scaling to the size of Content size just by simply overriding the Draw() event, without even executing any code inside of it.
Either way this trick got the work done. 😀 May be this is just a bug in Xamarin or iOS. 😛
There you have it, how to add a fixed background image to a UIScrollView from custom renderer in Xamarin! 🙂