i2 Connect SDK
Search results for

    Show/hide table of contents

    Home > @i2analyze/i2connect > records > ITypedSeededResultRecord > setProperty

    records.ITypedSeededResultRecord.setProperty() method

    Sets the value of a property on the result record.

    Signature:

    setProperty<TPropertyName extends utility.PropertyTypeDisplayNames<TItemType>>(displayName: TPropertyName, value: utility.PropertyValueType<utility.PropertyTypeFromDisplayName<TItemType, TPropertyName>> | undefined): void;
    

    Introduced: API version 1.0

    Type Parameters

    Parameter Type Description
    TPropertyName extends utility.PropertyTypeDisplayNames<TItemType> The type display name, which is inferred from the displayName parameter.

    Parameters

    Parameter Type Description
    displayName TPropertyName The display name of the property type.
    value utility.PropertyValueType<utility.PropertyTypeFromDisplayName<TItemType, TPropertyName>> | undefined The value for the property.

    Returns:

    void

    Remarks

    This method allows you to set a property on the record, given the display name of its property type from the schema.

    Example

    Use code like this to set an individual property on the seeded result record:

    seededResultRecord.setProperty('property name 1', 'property value');
    seededResultRecord.setProperty('property name 2', 4);
    
    In this article
    Back to top © N. Harris Computer Corporation