DeleteAll Method

DeleteAll method in the ABBYY FineReader Engine API — common method that removes all elements from a FineReader Engine collection.

This is a common method. Any platform-specific implementation limitations will be listed in the topics for the objects using this method.

This method is specific to ABBYY FineReader Engine collection objects. It removes all the elements from collection and empties it.

Syntax

C++

HRESULT DeleteAll();

C#

void DeleteAll();

Visual Basic .NET

Sub DeleteAll()

Return values

This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

Remarks

The following objects provide this method:

• Image-related objects:

  • OfficeConverters
  • TrainingImagesCollection

• Layout and blocks:

  • LayoutBlocks
  • CheckmarkGroup
  • SeparatorGroup
  • TableSeparators

• Language-related objects:

  • BaseLanguages
  • DictionaryDescriptions

• Text-related objects:

  • List
  • TabPositions

• Parameter objects:

  • PDFPictures

• Document-related objects:

  • AuthorsList
  • DocumentInformationDictionary

• Classification-related objects:

  • Categories
  • ClassificationObjects

• Supplementary objects:

  • IntsCollection
  • StringsCollection
  • RegionsCollection

• Visual Components supplementary objects:

  • SpellWordCollection
  • SpellReplacementCollection

Samples

C# code

FREngine.IEngine engine;
FREngine.IFRPage page;
FREngine.IImageModification imageModification;
// Remove all blocks from layout before image modification
page.Layout.Blocks.DeleteAll();
page.Layout.BlackSeparators.DeleteAll();
page.Layout.VisualBlocks.DeleteAll();
page.ImageDocument.Modify(imageModification);

The method is used in the following code samples for Linux and Windows: CustomLanguage.

See also

Working with Collections