GetByNumber Method (DocumentCollection)

Gets the document by specified number.

Syntax

public Document GetByNumber( 
   int number
)

Parameters

number

Type: System.Int32

The zero-based number of the document to get.

Return Value

Type: Zennolab.CommandCenter.Document

The document at the specified number.

Exceptions

Exception	Description
ArgumentOutOfRangeException	index is outside the range of valid indexes for the DocumentCollection.

Example

The following code example demonstrates that GetByNumber returns document of the current Tab object by number.

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
    DocumentCollection docCol = tab.AllDocuments;
    
    if (docCol.Count <= 0) return -1;
    
    // get document by number
    Document doc = docCol.GetByNumber(docCol.Count-1);
    
    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
    $docCol = $tab->AllDocuments;
    
    if ($docCol->Count <= 0) return -1;
    
    // get document by number
    $doc = $docCol->GetByNumber($docCol->Count-1);
    
    return 0;
}

Requirements

Target Platforms: Desktop: Windows XP SP3 and older. Server: Windows Server 2003 and older.

Reference

DocumentCollection Class
DocumentCollection Members
IndexOf Method
Count Property