Scontrol

Note

S-controls have been superseded by Visualforce pages. After March 2010 organizations that have never created s-controls, as well as new organizations, won't be allowed to create them. Existing s-controls will remain unaffected, and can still be edited. We recommend that you move your s-controls to Visualforce. We continue to support the Scontrol object.

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.

Supported Calls

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

Special Access Rules

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

Fields

Field	Details
Binary	Type base64 Properties Nillable, Update Description Binary content of this custom s-control, such as an ActiveX control or a Java archive. Can be specified when created, but not when updated. Limit: 5 MB.
BodyLength	Type int Properties Filter, Group, Sort Description The length of the custom s-control. Label is Binary Length.
ContentSource	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description 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	Type string Properties Filter, Group, Nillable, Sort, Update Description Description of the custom s-control.
DeveloperName	Type string Properties Filter, Group, Sort, Update Description 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	Type picklist Properties Filter, Group, Restricted picklist, Sort, Update Description 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	Type string Properties Filter, Group, Nillable, Sort, Update Description 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	Type textarea Properties Update Description 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	Type string Properties Filter, Group, Sort, Update Description Required. Name of this custom s-control. Label is Label.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 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	Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the s-control supports caching (`true`) or not (`false`).

Usage

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