IsSpreadsheetObject

Determines whether an object is a BoxLang spreadsheet object.

Method Signature

IsSpreadsheetObject(object=[any])

Arguments

Argument	Type	Required	Description	Default
value	ANY	true	The value to check.

Examples

Check if a value is a spreadsheet object:

// Check if variable is a spreadsheet
var spreadsheet = SpreadsheetNew();
if ( IsSpreadsheetObject( spreadsheet ) ) {
    println( "This is a valid spreadsheet object" );
}

Validate before operations:

// Ensure object is spreadsheet before manipulating
var data = SpreadsheetRead( "/path/to/file.xlsx" );

if ( !IsSpreadsheetObject( data ) ) {
    throw( "Invalid spreadsheet object" );
}

SpreadsheetAddRow( data, [ "Name", "Age" ] );

Type validation in functions:

// Type check in utility function
function processSpreadsheet( spreadsheetObj ) {
    if ( !IsSpreadsheetObject( spreadsheetObj ) ) {
        return { success = false, error = "Expected spreadsheet object" };
    }

    // Safe to process
    return { success = true, rows = SpreadsheetGetColumnCount( spreadsheetObj ) };
}

Related

• IsSpreadsheetFile() - Check for SpreadsheetFile objects

• SpreadsheetNew() - Create a spreadsheet

• SpreadsheetInfo() - Get spreadsheet information

• Type Checking Guide - BoxLang type validation