Scroll the document window to a specified graphic object

Question

Hi,
anyone knows  a way to scroll the document window to a specified graphic object?
I've tried with F_ApiScrollToText() function, but it works only with object containing text, and a graphic object ( like a line) doesn't contain text...
Thanks in advance.

Answer 1

Hi Stemen82,
I have dealt with this in the past and found it to be a bit complex. I've pasted below the functions I came up with to do it. Note that:
- I'm not sure that it works in all cases. Because there is no direct FDK function to do this, you really have to monkey around with things to get it done.
- The code I've pasted should handle both anchored frames and graphic objects, including "floating" graphics. Anchored frames are actually a bit more straightforward because you can get the text location of the anchor.
- All the comments in the code are "notes to self." That is, I didn't write them for you   However, they should be of some use to you.
- There may be plenty of other, better ways to do this... this is just what I slapped together to get the basic functionality to work.
Russ
//THIS IS REALLY ONLY GOOD FOR ONE LEVEL OF NESTING,
// ie, one graphic in one anchored frame, in a text frame.
// No testing or implementation for anything else at this point.
//If you don't know whether the object is a graphic or an anchored
//frame, you can send it as the graphic ID and the function will
//figure it out.
// So, either send a graphic ID as graphicId,
// a frame ID as graphicId, or both graphic and frame IDs.
// Don't sent just a frame ID as frameID.
VoidT ws_SelectAndScrollToGraphic(F_ObjHandleT docId,
                                  F_ObjHandleT graphicId,
                                  F_ObjHandleT frameId)
  F_ObjHandleT aFrameId = 0,
    textFrameId,
    graphicPageId,
    currentPageId,
    tempGraphicId;
  IntT objectType,
    alreadySelected = False;
  F_TextRangeT tr;
  if(!docId || (!graphicId && !frameId)) return;
  //let's get the page. We might need it for scrolling and
  //maybe to switch to the correct page type
  graphicPageId = ws_GetPageForGraphic(docId, graphicId);
  //So far, two possibilities here, either an anchored frame somewhere in the object hierarchy or not.
  //If there is no anchored frame, we have to guess based on pages and paragraps.  If there is one,
  //we can jump to the anchor.
  //let's start by looking for an anchored frame if one was not sent
  if(graphicId && !frameId)
    objectType = F_ApiGetObjectType(docId, graphicId);
    //if we actually got an anchored frame, we will store the ID.
    if(objectType == FO_AFrame)
      aFrameId = graphicId;
    //otherwise, let's look above to see if there is an anchored frame
    else
      aFrameId = F_ApiGetId(docId, graphicId, FP_FrameParent);
      objectType = F_ApiGetObjectType(docId, aFrameId);
      if(objectType != FO_AFrame)
        aFrameId = 0;
  //at this point, if we have an anchored frame, scroll to it
  if(aFrameId)
    //let's switch to the appropriate page type, only if necessary
    //we'll do that by simply switching to the first page of that
    //type in the doc before the scroll action
    currentPageId = F_ApiGetId(FV_SessionId, docId, FP_CurrentPage);
    if(F_ApiGetObjectType(docId, graphicPageId) != F_ApiGetObjectType(docId, currentPageId))
      if(F_ApiGetObjectType(docId, graphicPageId) == FO_MasterPage)
        currentPageId = F_ApiGetId(FV_SessionId, docId, FP_FirstMasterPageInDoc);
      else if(F_ApiGetObjectType(docId, graphicPageId) == FO_RefPage)
        currentPageId = F_ApiGetId(FV_SessionId, docId, FP_FirstRefPageInDoc);
      else
        currentPageId = F_ApiGetId(FV_SessionId, docId, FP_FirstBodyPageInDoc);
      F_ApiSetId(FV_SessionId, docId, FP_CurrentPage, currentPageId);
    tr.beg = tr.end = F_ApiGetTextLoc(docId, aFrameId, FP_TextLoc);
    F_ApiScrollToText(docId, &tr);
  //if no anchored frame (ie, just a floating graphic),
  //let's finangle with some paragraphs and pages and try our
  //best. There might be a better way.
  else
    // We have the page that the graphic is on, let's at least jump
    // to that page, maybe we can get a little closer later
    F_ApiSetId(FV_SessionId, docId, FP_CurrentPage, graphicPageId);
    //get the parent frame of the graphic which is hopefully a text frame
    textFrameId = F_ApiGetId(docId, graphicId, FP_FrameParent);
    //let's see if we can find a paragraph and scroll to it.
    tr.beg.objId = tr.end.objId =
      F_ApiGetId(docId, textFrameId, FP_FirstPgf);
    F_ApiScrollToText(docId, &tr);
  //now, let's do the selection. We'll unselect everything
  //that is selected, unless our graphic is already selected.
  tempGraphicId = F_ApiGetId(FV_SessionId, docId, FP_FirstSelectedGraphicInDoc);
  while(tempGraphicId)
    if(tempGraphicId == graphicId || tempGraphicId == frameId)
      alreadySelected = True;
    else
      F_ApiSetInt(docId, tempGraphicId, FP_GraphicIsSelected, False);
    tempGraphicId = F_ApiGetId(docId, tempGraphicId, FP_NextSelectedGraphicInDoc);
  if(!alreadySelected)
    if(graphicId)
      F_ApiSetInt(docId, graphicId, FP_GraphicIsSelected, True);
    else
      F_ApiSetInt(docId, frameId, FP_GraphicIsSelected, True);
//Returns the ID of the page that the graphic is on.
F_ObjHandleT ws_GetPageForGraphic(F_ObjHandleT docId,
                                  F_ObjHandleT graphicId)
  F_ObjHandleT tempGraphicId = 0,
    pageId = 0;
  while(graphicId)
    tempGraphicId = graphicId;
    graphicId = F_ApiGetId(docId, graphicId, FP_FrameParent);
  if(tempGraphicId)
    pageId = F_ApiGetId(docId, tempGraphicId, FP_PageFramePage);
  return pageId;