Scontrol

Note

Salesforce.com expects to make s-controls, including the Scontrol object, unavailable in the near future. We recommend that you move your s-controls to Visualforce where possible. We will continue to support s-controls and the Scontrol object for the time being. For more information about our support policy, see API Support Policy.

Represents a custom s-control, which is custom content that is hosted by the system but executed by client applications. An s-control can contain any type of content that you can display or run in a Web browser. See “Defining Custom S-Controls” in the Salesforce.com online help.

Supported Calls

create(), update(), delete(), describeSObjects(), query(), retrieve(), getDeleted(), getUpdated()

Special Access Rules

Your organization must be using Enterprise, Developer, or Unlimited Edition and be enabled for custom s-controls.
Customer Portal users cannot access this object.

Fields

Field	Field Type	Field Properties	Description
Binary	base64	Create Nillable Update	Binary content of this custom s-control, such as an ActiveX control or a Java archive. Can be specified when your client application calls `create()`, but not when calling `update()`. Limit: 5 MB.
BodyLength	int	Filter	The length of the custom s-control. Label is Binary Length.
ContentSource	picklist	Create Filter Nillable Restricted picklist Update	Specify the source of the s-control content, either custom HTML, a snippet (s-controls that are designed to be included in other s-controls), or a URL.
Description	string	Create Filter Nillable Update	Description of the custom s-control.
DeveloperName	string	Create Filter Nillable Update	The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your organization. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object's name in a managed package and the changes are reflected in a subscriber's organization. Label is S-Control Name.
EncodingKey	picklist	Create Filter Restricted picklist Update	Picklist of character set encodings, including ISO-08859-1, UTF-8, EUC, JIS, Shift-JIS, Korean (ks_c_5601-1987), Simplified Chinese (GB2312), and Traditional Chinese (Big5).
Filename	string	Create Filter Nillable Update	An uploaded object to display when the custom s-control is added to a custom link. Can be a Java applet, an ActiveX control, or any other type of desired content.
HtmlWrapper	textarea	Create Update	Required. HTML page that will be delivered when the user views this custom s-control. This HTML page can be the entire content of the custom s-control, or it can reference the binary. Limit: 1,048,576 characters. Label is HTML Body.
Name	string	Create Filter idLookup Nillable Update	Required. Name of this custom s-control. Label is Label.
NamespacePrefix	string	Filter Nillable	The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. The limit is 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values: In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This is the namespace prefix of the Developer Edition organization of the package developer. In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.
SupportsCaching	boolean	Create Filter Update	Indicates whether the s-control supports caching (`true`) or not (`false`).

Usage

Use custom s-controls to manage custom content that extends the base Salesforce.com application functionality. All users can view custom s-controls, but the “Customize Application” permission is required to create() or update() custom s-controls.