Setting contentOffset programmatically triggers scrollViewDidScroll

Question

I've got a a few UIScrollView on a page. You can scroll them independently or lock them together and scroll them as one. The problem occurs when they are locked.

I use UIScrollViewDelegate and scrollViewDidScroll: to track movement. I query the contentOffset of the UIScrollView which changed and then reflect change to other scroll views by setting their contentOffset property to match.

Great.... except I noticed a lot of extra calls. Programmatically changing the contentOffset of my scroll views triggers the delegate method scrollViewDidScroll: to be called. I've tried using setContentOffset:animated: instead, but I'm still getting the trigger on the delegate.

How can I modify my contentOffsets programmatically to not trigger scrollViewDidScroll:?

Implementation notes.... Each UIScrollView is part of a custom UIView which uses delegate pattern to call back to the presenting UIViewController subclass that handles coordinating the various contentOffset values.

I have the same problem, I am using a UITextView in a UITableView, when the text view is resized, UITableView->scrollViewDidScroll is trigged ;-( — Thomas Decaux
– Thomas Decaux, Commented Jun 29, 2012 at 13:16
Tarc's answer worked perfectly. Since then I hae come to understand modifying bounds property and gained an understanding of what is occurring. — DBD
– DBD, Commented Jun 29, 2012 at 13:54

Tark · Accepted Answer · 2012-02-23 18:05:05Z

114

It is possible to change the content offset of a UIScrollView without triggering the delegate callback scrollViewDidScroll:, by setting the bounds of the UIScrollView with the origin set to the desired content offset.

CGRect scrollBounds = scrollView.bounds;
scrollBounds.origin = desiredContentOffset;
scrollView.bounds = scrollBounds;

answered Feb 23, 2012 at 18:05

Tark

5,1653 gold badges27 silver badges23 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Tark Over a year ago

why so leery my man? it is all the content offset is really, and can be animated using UIView animation blocks and stuff.

user317033 Over a year ago

This still makes another call to scrollViewDidScroll, but it does not do so until after the current scrollViewDidScroll function ends.

SimplGy Over a year ago

@Mark -- I don't see this queuing a call to scrollViewDidScroll. Is there some situation this would happen in?

Abhijit · Accepted Answer · 2013-07-25 11:10:25Z

83

Try

id scrollDelegate = scrollView.delegate;
scrollView.delegate = nil;
scrollView.contentOffset = point;
scrollView.delegate = scrollDelegate;

Worked for me.

answered Jul 25, 2013 at 11:10

Abhijit

9716 silver badges3 bronze badges

Comments

aheze · Accepted Answer · 2021-11-13 21:35:08Z

63

What about using existing properties of UIScrollView?

func scrollViewDidScroll(_ scrollView: UIScrollView) {
    if (scrollView.isTracking || scrollView.isDragging || scrollView.isDecelerating) {
        /// The content offset was changed programmatically.
        /// Your code goes here.
    }
}

edited Nov 13, 2021 at 21:35

aheze

31.5k12 gold badges107 silver badges159 bronze badges

answered Nov 8, 2014 at 16:35

Kukosk

3,0421 gold badge29 silver badges31 bronze badges

8 Comments

DBD Over a year ago

Possible, but fragile. If the UIScrollView API changed by even adding a new similar property it would cause your code to break. You would also have to worry about the flag these flags being gone. After all, I was checking in "did change" and the scroll view might no longer have the flag because the action is complete.

Shaheen Ghiassy Over a year ago

@DBD - If you worried about about every API changing in UIKit I don't know how you would get anything done. Relying on publicly documented APIs is not fragile.

DBD Over a year ago

@Shaheen - I'm not saying the solution is made of spun glass, but I found it to be less future proof than desired. The premise of the solution is checks 3 potential activities and if it's not those activities assume by process of elimination it is the 4th. My concern isn't about Apple just changing a public API, it's about Apple adding functionality to the API which would require a logic update in order for the code to continue functioning and Apple does make additions to the UIKit quite regularly, both as new classes and additions to existing classes. It's ok if you don't like my reasons.

Shaheen Ghiassy Over a year ago

@DBD - I can agree with you that "The premise of the solution is checks 3 potential activities and if it's not those activities assume by process of elimination it is the 4th"is less than desirable logic.

Marchy Over a year ago

Best answer on here by far. Unlike the bounds solution, it is not some mysterious side-effect that absolutely COULD change with future behaviour, and the likelihood of scroll-view having new concepts introduced is really low unless new touch interaction kinds get introduced – which let's face it, 10 years into iOS (we're even passed force touch now) is highly unlikely to happen. And if it does... big whoop, add one more interaction to your code and you're done. Could even spin it into an extension (with 'ieUserInteracting' property) and handles all your scroll views in one shot. Done.

|

Jake MacMullin · Accepted Answer · 2014-09-11 01:39:33Z

10

Another approach is to add some logic in your scrollViewDidScroll delegate to determine whether or not the change in content offset was triggered programatically or by the user's touch.

Add an 'isManualScroll' boolean variable to your class.
Set its initial value to false.
In scrollViewWillBeginDragging set it to true.
In your scrollViewDidScroll check to see that is it true and only respond if it is.
In scrollViewDidEndDecelerating set it to false.
In scrollViewWillEndDragging add logic to set it to false if the velocity is 0 (as scrollViewDidEndDecelerating won't be called in this case).

answered Sep 11, 2014 at 1:39

Jake MacMullin

2393 silver badges4 bronze badges

1 Comment

Chris Chute Over a year ago

Best answer here. One modification though: I'd use scrollViewDidEndDragging(_:willDecelerate:) instead of scrollViewWillEndDragging. Then instead of checking that the velocity is 0, you check that decelerate is false, which explicitly tells you that scrollViewWillEndDecelerating will not get called.

SimplGy · Accepted Answer · 2015-03-10 12:33:09Z

6

Simplifying @Tark's answer, you can position the scrollview without firing scrollViewDidScroll in one line like this:

scrollView.bounds.origin = CGPoint(x:0, y:100); // whatever values you'd like

answered Mar 10, 2015 at 12:33

SimplGy

20.5k15 gold badges112 silver badges154 bronze badges

1 Comment

brandonscript Over a year ago

Not sure what's going on, but in Xcode 9 - building for iOS 11, even when setting bounds, scrollViewDidScroll appears to fire.

David Hoerl · Accepted Answer · 2012-03-31 21:00:26Z

4

This is not a direct answer to the question, but if you are getting what appear to be spurious such messages, it can ALSO be because you are changing the bounds. I am using some Apple sample code with a "tilePages" method that removes and adds subview to a scrollview. This infrequently results in additional scrollViewDidScroll: messages called immediately, so you get into a recursion which you for sure didn't expect. In my case I got a nasty impossible to find crash.

What I ended up doing was queuing the call on the main queue:

- (void)scrollViewDidScroll:(UIScrollView *)scrollView
{
    if(scrollView == yourScrollView) {
        // dispatch fixes some recursive call to scrollViewDidScroll in tilePages (related to removeFromSuperView)
        // The reason can be found here: http://stackoverflow.com/questions/9418311
        dispatch_async(dispatch_get_main_queue(), ^{ [self tilePages]; });
    }
}

answered Mar 31, 2012 at 21:00

David Hoerl

41.9k14 gold badges98 silver badges143 bronze badges

1 Comment

DBD Over a year ago

Interesting, while not my issue in this case I'll keep this in mind.

Collectives™ on Stack Overflow

Setting contentOffset programmatically triggers scrollViewDidScroll

6 Answers 6

3 Comments

Comments

8 Comments

1 Comment

1 Comment

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

3 Comments

Comments

8 Comments

1 Comment

1 Comment

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related