ImageGear .NET v25.2 - Updated
ImageGear.Web.Isis Library / ImageGear.Web.Isis Namespace / ImGearIsisScanner class / setTagString Method

In This Topic
    setTagString Method
    In This Topic
    Sets the value of an ISIS tag of data type String.
    Syntax
    ASP.NET Ajax JavaScript (Specification) 
    function setTagString( 
       tagID : number(Integer),
       tagString : string,
       callback : function
    ) : ImGearIsisOperationStatus;
    ASP.NET Ajax JavaScript (Usage) 
    var resultVar = instanceOfImGearIsisScanner.setTagString(number(Integer),string,function);

    Parameters

    tagID
    The ID of the tag.
    tagString
    The string value to set the tag to.
    callback
    Callback which is called when the tag is set.

    Return Value

    Example

    The JavaScript code below demonstrates how to set a scanner ISIS page size tag to a string value. You can use the getTag method to get the tag type and list or range of supported values for a tag.

    function setTagCallback(status) {
        if (status.get_status() !== ImageGear.Web.Isis.ImGearIsisStatus.Completed) {
            alert(status.get_statusMessage());
        }
    }
    
    scannerSession.get_scanner().setTagString(ImageGear.Web.Isis.ImGearIsisTag.PageSize, "Letter - 8.5 x 11 in", setTagCallback);
    Remarks

    This is an asynchronous method.

    To set the values of multiple tags, it is more efficient to use setAllTags.

    The scanner must be set before calling this method.

    For more information on ISIS tags, refer to the ISIS Tags topic.

    See Also