EnhEvents.AddText

[This is preliminary documentation and subject to change.]

The AddText method adds an event to the enhancement stream using the stream language.

Syntax

object.AddText( sText )

Parts

object: Object expression that resolves to an EnhEvents object.
sText: String that contains the stream language. This value is used to initialize the EnhEvent.Text property of the new event. If this string is empty (""), the event is not added.
To locate more information about stream compiler language syntax, see Further Information on Data Services for the Client.

Remarks

You can also use this method to set the value of enhancement stream global variables, namely BandWidth, Href, FrameName, Overhead, Priority, FPS, Redundancy, TimeOut, LeadTime, Style, ShowLength, and ShowName. The value of these global variables are wrapped by the EnhEvents properties of the same name.

For example, you can set the value of EnhEvents.Redundancy to 10 with the following:

evs.AddText("Redundancy = 10;")

QuickInfo

  Windows NT: Unsupported.
  Windows: Requires Windows 98.
  Windows CE: Unsupported.
  Header: Declared in stream.idl.
  Import Library: Included as a resource in stream.dll.
  Unicode: Yes.

Examples

The following example adds a Nav trigger event to the enhancement stream. Note that because the only keyword is specified, the file NewEnh.htm is assumed to already exist on the client's computer and is not scheduled to be transmitted.

evs.AddText("00:10:30:00 trigger ( 2 <NewEnh.htm>[targ:Left]) only;")

The next example adds an announcement to the enhancement stream. Note that before you can transmit this event, you must build the announcement file, in this case MyAnnc.ann. For more information on how to do this, see Creating Enhancement Announcements.