API reference / Common / UDocSearchScope

Type Alias: UDocSearchScope

type UDocSearchScope = 
  | {
  image: ImageSearchScope;
}
  | {
  portable: PortableSearchScope;
}
  | {
  presentation: PresentationSearchScope;
}
  | {
  spreadsheet: SpreadsheetSearchScope;
}
  | {
  wordprocessing: WordprocessingSearchScope;
};

Top-level search scope for a loaded document — the part of it a search covers, a format-agnostic enum over the per-doc-type scopes, externally tagged by doc type like [UDocSelection] — e.g. {"portable":{"pages":{"start":0,"end":5}}}. A search naming none covers the whole document.