GeneratePreview Method (DisplayableCampaignItem)

2009-11-12

Generate the HTML preview for a CampaignItem given the template and property set to use for the preview.

Namespace: Microsoft.CommerceServer.Marketing
Assembly: Microsoft.CommerceServer.Marketing.CrossTierTypes (in Microsoft.CommerceServer.Marketing.CrossTierTypes.dll)

Syntax

'Declaration
Public Function GeneratePreview ( _
    campaignItem As DisplayableCampaignItem _
) As String

'Usage
Dim instance As CampaignItemManager
Dim campaignItem As DisplayableCampaignItem
Dim returnValue As String

returnValue = instance.GeneratePreview(campaignItem)

public string GeneratePreview(
    DisplayableCampaignItem campaignItem
)

public:
String^ GeneratePreview(
    DisplayableCampaignItem^ campaignItem
)

public function GeneratePreview(
    campaignItem : DisplayableCampaignItem
) : String

Parameters

campaignItem
Type: Microsoft.CommerceServer.Marketing..::.DisplayableCampaignItem
A DisplayableCampaignItem for which a preview is generated.

Return Value

Type: System..::.String
A DisplayableCampaignItem containing the HTML or XML for the rendered (formatted) campaign item.

Exceptions

Exception	Condition
ArgumentNullException	The campaignItem parameter is a nullNothingnullptra null reference (Nothing in Visual Basic) reference (Nothing in Visual Basic).

Remarks

Calls the GeneratePreview with the context parameter (the dictionary) set to nullNothingnullptra null reference (Nothing in Visual Basic).

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via