Package com.ebasetech.xi.api
Interface Project
public interface Project
-
Method Summary
Modifier and Type Method Description java.lang.String
getName()
Returns the project name for the project.java.lang.String
getTheme()
Returns the path of the theme currently set on the project or null if no theme is configured.void
setTheme(java.lang.String theme)
Changes the Theme for the Project.
-
Method Details
-
setTheme
void setTheme(java.lang.String theme) throws com.ebasetech.xi.exceptions.FormRuntimeExceptionChanges the Theme for the Project. This will change all the forms in the Project that are set to use the Project's Theme to the one at the specified path.The path should be relative to the root of the Project or one of its dependent projects. It must start with a forward slash as a path separator.
The new Theme must have the same Framework and collection of Property Sets as the current Theme otherwise the Form may not look as expected.
Important:
project.setTheme(...)
must be on the last line of a script. After the setTheme function call is executed, the next script configured in the server event will be executed.For further information see:
JavaScript example:
var project = projects.myProject; project.setTheme("/themes/myTheme");
- Parameters:
theme
- the path of the new theme to be applied- Throws:
com.ebasetech.xi.exceptions.FormRuntimeException
- Since:
- V5.13
-
getTheme
java.lang.String getTheme()Returns the path of the theme currently set on the project or null if no theme is configured.- Returns:
- the theme path
- Since:
- V5.13
-
getName
java.lang.String getName()Returns the project name for the project.- Returns:
- project name
- Since:
- V5.13
-