StringParam — Natron 2.5.0 documentation

# StringParam

Inherits StringParamBase

## Synopsis

This parameter is used to contain a string. See here for more details.

### Functions

- def `setType` (type)

## Detailed Description

A StringParam can have several forms on the user interface, depending on its type

Here are the different types of string parameters:

A basic string that can be edited by the user

A non animating label string that the user cannot edit

A multi-line string that the user can edit and animate

A multi-line string with rich text support with a subset of html

### Member functions description

NatronEngine.StringParam.setType(type)
  Parameters

    type – `NatronEngine.StringParam.TypeEnum`

Set the type of the StringParam. This should be called right away after creation time.

Warning

Once called, you should call `refreshUserParamsGUI()` to update the user interface.