Site.getAlternateImageFormatList (Method)
Returns zero or more structures, each containing information about alternate image formats for a site. For example, each structure contains a description of the alternate format, height and width constraints, and so on.
Returns:
Site_getAlternateImageFormatList_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| AlwaysGenerate | Boolean | Boolean flag which when true indicates that CommonSpot always generates this alternate format. |
| Description | PlainText_2000 | The alternate format's description. |
| DisplayName | PlainText_NonNull_255 | The alternate format's display name. |
| generateVersions | Boolean | Boolean flag which when true indicates that the alternate format can store past versions. |
| Height | NonNegativeInteger | The height at which CommonSpot creates the image. If this value is 0, CommonSpot does not change the image's height. |
| IsFactory | Boolean | Boolean flag which when true indicates that the alternate format is factory-specified. |
| LcaseName | PlainText_NonNull_50 | The alternate format's lowercase name. |
| MaxHeight | NonNegativeInteger | The alternate format's maximum height. |
| MaxWidth | NonNegativeInteger | The alternate format's maximum width. |
| Name | PlainText_NonNull_50 | The alternate format's name. This name cannot contain spaces. |
| OperationModule | Any | The name of the module CommonSpot calls when it makes custom transformations. |
| SupportedFormats | PlainText_NonNull | A comma-delimited list of supported image formats; for example, 'png,gif'. |
| Width | NonNegativeInteger | The width at which CommonSpot creates the image. If this value is 0, CommonSpot does not change the image's width. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| formatName | AlternateImageFormat_EmptyString | Optional. Defaults to an empty string. | The name of the alternate image format to return data for. If an empty string all formats are returned. |
Context:
| License Requirements | None |
| Permission Requirements | ContributorOrServerCode |
| Deny Context | None |
| Require Context | None |
| Author Lock |
Error Codes:
None
Notes:
None