Scontrol

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 online help.

Supported Calls

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

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. The name can contain only alphanumeric characters and must begin with a letter. 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 Create

Filter

Nillable

The namespace prefix assigned to this object when it was created as part of a managed package. Null if this object is not part of a managed package. Limit is 15 characters. For more information about managed packages and namespace prefixes, see "About Managed Packages" in the Salesforce online help.

You can use this field to identify rows that belong to a particular managed package, for example, identifying the tabset that was installed with a particular managed package.

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 application functionality. All users can view custom s-controls, but the “Customize Application” permission is required to create() or update() custom s-controls.

See Also:
Standard and Custom Object Basics
© Copyright 2000-2008 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.