InsertRange(DocumentCollection,Int32) Method

Inserts the documents of a collection into the DocumentCollection at the specified index.

Syntax

public void InsertRange( 
   DocumentCollection documents,
   int index
)

Parameters

documents

Type: Zennolab.CommandCenter.DocumentCollection

The collection whose elements should be inserted into the DocumentCollection. The collection itself cannot be null.

index

Type: System.Int32
The zero-based index at which the new documents should be inserted.

Exceptions

Exception	Description
ArgumentOutOfRangeException	index is less than 0 or index is greater than Count.

Remarks

If index is equal to Count, the elements are added to the end of DocumentCollection. The order of the elements in the collection is preserved in the DocumentCollection.

Example

The following code example demonstrates InsertRange method.

public static int Execute(Instance instance, IZennoPosterProjectModel project)
{
    // clear cookie
    instance.ClearCookie();
    
    // go to zennolab.com
    Tab tab = instance.MainTab;
    if ((tab.IsVoid) || (tab.IsNull)) return -1;
    if (tab.IsBusy) tab.WaitDownloading();
    tab.Navigate("zennolab.com");
    if (tab.IsBusy) tab.WaitDownloading();
    
    // get all documents from zennolab.com
    DocumentCollection docCol = tab.AllDocuments;
    
    // go to lessons.zennolab.com
    tab.Navigate("lessons.zennolab.com");
    if (tab.IsBusy) tab.WaitDownloading();
    
    // go to lessons.zennolab.com
    DocumentCollection newDocCol = tab.AllDocuments;
    
    // insert second collection to first collection start with 0 index
    docCol.InsertRange(newDocCol, 0);
    
    return 0;
}

public static function Execute($instance, $project)
{
    // clear cookie
    $instance->ClearCookie();
    
    // go to zennolab.com
    $tab = $instance->MainTab;
    if (($tab->IsVoid) || ($tab->IsNull)) return -1;
    if ($tab->IsBusy) $tab->WaitDownloading();
    $tab->Navigate("zennolab.com");
    if ($tab->IsBusy) $tab->WaitDownloading();
    
    // get all documents from zennolab.com
    $docCol = $tab->AllDocuments;
    
    // go to lessons.zennolab.com
    $tab->Navigate("lessons.zennolab.com");
    if ($tab->IsBusy) $tab->WaitDownloading();
    
    // go to lessons.zennolab.com
    $newDocCol = $tab->AllDocuments;
    
    // insert second collection to first collection start with 0 index
    $docCol->InsertRange($newDocCol, 0);
    
    return 0;
}

Requirements

Target Platforms: Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family, Windows Seven

Reference

DocumentCollection Class
DocumentCollection Members
Overload List
Insert Method
Add Method
AddRange Method
Remove Method