Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Elements' Summary Elements' Details

:: com :: sun :: star :: ucb ::

struct SearchInfo
Description
information needed to (recursively) search an object.
Elements' Summary
Criteria the search criteria.  
Recursion the mode of recursion to use.  
IncludeBase whether to include the object itself in the search or only (some of) its sub-objects.  
RespectFolderViewRestrictions whether to respect the "view restrictions" specified for the folders hierarchically contained within an object (e.g., only searches through subscribed folders).  
RespectDocViewRestrictions whether to respect the "view restrictions" specified for the documents hierarchically contained within an object (e.g., only searches through marked documents).  
FollowIndirections whether to follow indirections (link objects) and search through their respective targets also.  
Elements' Details
Criteria
sequence< SearchCriterium > Criteria;
Description
the search criteria.
Recursion
SearchRecursion Recursion;
Description
the mode of recursion to use.
IncludeBase
boolean IncludeBase;
Description
whether to include the object itself in the search or only (some of) its sub-objects.
RespectFolderViewRestrictions
boolean RespectFolderViewRestrictions;
Description
whether to respect the "view restrictions" specified for the folders hierarchically contained within an object (e.g., only searches through subscribed folders).
RespectDocViewRestrictions
boolean RespectDocViewRestrictions;
Description
whether to respect the "view restrictions" specified for the documents hierarchically contained within an object (e.g., only searches through marked documents).
FollowIndirections
boolean FollowIndirections;
Description
whether to follow indirections (link objects) and search through their respective targets also.
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.