ZennoLab Assemblies Documentation
GetByNumber Method
See Also  Example Send Feedback
ZennoLab.CommandCenter Assembly > ZennoLab.CommandCenter Namespace > DocumentCollection Class : GetByNumber Method
number

Type: System.Int32

The zero-based number of the document to get.

Glossary Item Box

Gets the document by specified number.

Syntax

C# 
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

ExceptionDescription
ArgumentOutOfRangeExceptionindex 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.
C#Copy Code
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;
}
PHPCopy Code
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: Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2013 All Rights Reserved.