SftOptions 1.0

SftOptions.DefaultTopicPicture Property

Softel vdm, Inc.

Defines the default picture used for topics.

Syntax       

Get

VB.NET

refPictureObj = object.DefaultTopicPicture  As System.Drawing.Image
refPictureObj = object.DefaultTopicPicture  As stdole.IPictureDisp  Note

VB

Set refPictureObj = object.DefaultTopicPicture  As IPictureDisp

C#.NET

System.Drawing.Image refPictureObj = object.DefaultTopicPicture;
stdole.IPictureDisp refPictureObj = object.DefaultTopicPicture;  Note

VC++

IPictureDisp* refPictureObj = object->GetDefaultTopicPicture();

C

HRESULT object->get_DefaultTopicPicture(IPictureDisp** refPictureObj);

Delphi

refPictureObj := object.DefaultTopicPicture  : TPicture;
refPictureObj := object.DefaultTopicPicture  : IPictureDisp;  Note

Put

VB.NET

object.let_DefaultTopicPicture(ByVal refPictureObj As stdole.IPictureDisp)  Note

VB

object.DefaultTopicPicture = refPictureObj  As IPictureDisp

C#.NET

void object.let_DefaultTopicPicture(stdole.IPictureDisp refPictureObj);  Note

VC++

void object->PutDefaultTopicPicture(IPictureDisp* refPictureObj);

C

HRESULT object->put_DefaultTopicPicture(IPictureDisp* refPictureObj);

Delphi

procedure object._Set_DefaultTopicPicture(refPictureObj : IPictureDisp);  Note

PutRef

VB.NET

object.DefaultTopicPicture = refPictureObj  As System.Drawing.Image
object.DefaultTopicPicture = refPictureObj  As stdole.IPictureDisp  Note

VB

Set object.DefaultTopicPicture = refPictureObj  As IPictureDisp

C#.NET

System.Drawing.Image object.DefaultTopicPicture = refPictureObj;
stdole.IPictureDisp object.DefaultTopicPicture = refPictureObj;  Note

VC++

void object->PutRefDefaultTopicPicture(IPictureDisp* refPictureObj);

C

HRESULT object->putref_DefaultTopicPicture(IPictureDisp* refPictureObj);

Delphi

object.DefaultTopicPicture := refPictureObj  : TPicture;
object.DefaultTopicPicture := refPictureObj  : IPictureDisp;  Note

object

A SftOptions object.

refPictureObj

Defines the default picture used for topics.

Comments

The DefaultTopicPicture property defines the default picture used for topics.

Individual entries can override the default topic picture by using the SftOptionsEntry.Picture property.

To restore the control's built-in default image, set the property to Nothing (0, null, NULL).  It is not possible to completely remove topic pictures.

Example (VB.NET)

' A picture box is used to hold the bitmap for the DefaultTopicPicture property. A suitable 
' bitmap has been defined in the picture box using its Image property.
AxSftOptions1.DefaultTopicPicture = PictureBox1.Image
AxSftOptions1.Add("", "Topic1", "Sample Topic", SftOptionsEntryConstants.entrySftOptionsTopic, _
     "", "", Nothing, "", "", "", "")
AxSftOptions1.InitializationComplete()

Example (VB)

' A picture box is used to hold the bitmap for the DefaultTopicPicture property. A suitable
' bitmap has been defined in the picture box using its Picture property.
SftOptions1.DefaultTopicPicture = Picture1.Picture
SftOptions1.Add "", "Topic1", "Sample Topic", entrySftOptionsTopic, "", "", _
    Nothing, "", "", "", ""
SftOptions1.InitializationComplete

Example (C#.NET)

// A picture box is used to hold the bitmap for the DefaultTopicPicture property. A suitable 
// bitmap has been defined in the picture box using its Image property.
axSftOptions1.DefaultTopicPicture = pictureBox1.Image;
axSftOptions1.Add("", "Topic1", "Sample Topic", SftOptionsEntryConstants.entrySftOptionsTopic,
     "", "", null, "", "", "", "");
axSftOptions1.InitializationComplete();

Example (VC++)

ISftOptionsPtr vOptions1 = m_Options1.GetControlUnknown();

IPictureDispPtr pIPictureDisp;
PICTDESC PictDesc;
PictDesc.cbSizeofstruct = sizeof(PICTDESC);
PictDesc.picType = PICTYPE_ICON;
PictDesc.icon.hicon = LoadIcon(NULL, MAKEINTRESOURCE(IDI_APPLICATION));
HRESULT hr = OleCreatePictureIndirect(&PictDesc, IID_IPictureDisp, TRUE, (void**)&pIPictureDisp);
ASSERT(SUCCEEDED(hr));

vOptions1->PutRefDefaultTopicPicture(pIPictureDisp);
vOptions1->Add(_bstr_t(""), _bstr_t("Topic1"), _bstr_t("Sample Topic"), 
    entrySftOptionsTopic, _bstr_t(""), _bstr_t(""), NULL,
    _bstr_t(""), _bstr_t(""), _bstr_t(""), _bstr_t(""));
vOptions1->InitializationComplete();

Example (Delphi)

// A TImage control is used to hold the bitmap for the DefaultTopicPicture property. A suitable
// bitmap has been defined in the image control using its Picture property.
SftOptions1.DefaultTopicPicture := Image1.Picture;
SftOptions1.Add('', 'Topic1', 'Sample Topic', entrySftOptionsTopic, '', '', nil, '', '', '', '');
SftOptions1.InitializationComplete();

See Also  SftOptions Object | Object Hierarchy


Feedback / comments / error reports for this topic
© 2002 - Softel vdm, Inc. - www.softelvdm.com