Description
DesignObject.PicturePath Property |
Description
Sets or returns the picture object's path. Applies to picture objects.
Syntax DesignObject.PicturePath = PathAndFileName
Where PathAndFileName is a string containing the path to the picture.
Requirements |
Version |
BarTender 9.3 or higher |
|
Edition |
Automation, Enterprise |
Remarks
The DesignObject.PicturePath property sets or returns a path to a desired picture. The path is different based on the picture object's source.
When retrieving information about a picture object...
If the picture is embedded into the picture object, the DesignObject.PicturePath property will return the original file name that was used when the image was embedded into the document.
If the picture is linked to an image file, the DesignObject.PicturePath property will return the linked file name.
If the picture object is data-sourced, the DesignObject.PicturePath property will return the default path of the data-sourced picture.
When setting the path to an image...
If the picture is embedded into the picture object, the DesignObject.PicturePath property will set the embedded file name, then open and load the image. The extension of the file name will be used to determine the type of image (i.e. JPG, GIF, PNG, etc). If the specified file name cannot be found, an exception will be thrown.
If the picture is linked to an image file, the DesignObject.PicturePath property will set the file name, then open and load the image. The extension of the file name will be used to determine the type of image (i.e. JPG, GIF, PNG, etc). If the specified file name cannot be found or loaded, an exception will be thrown.
If the picture object is data-sourced, the DesignObject.PicturePath property will set the default path of the data-sourced picture.
VB.NET Example
'Declare a BarTender application variable
Dim btApp As BarTender.Application
'Declare a BarTender document variable
Dim btFormat As BarTender.Format
'Declare a BarTender design object variable
Dim btObject As BarTender.DesignObject
'Create a new instance of BarTender
btApp = New BarTender.Application
'Set the BarTender application visible
btApp.Visible = True
'Open a BarTender document
btFormat = btApp.Formats.Open("c:\Format1.btw", False, "")
'Set the object variable
btObject = btFormat.Objects.Find("Picture 1")
'Set the picture path
btObject.PicturePath = "c:\MyPicture.jpg"
'End the BarTender process
btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges)
C# Example
// Declare a BarTender application variable
BarTender.Application btApp;
// Declare a BarTender document variable
BarTender.Format btFormat;
// Declare a BarTender design object variable
BarTender.DesignObject btObject;
// Create a new instance of BarTender
btApp = new BarTender.Application();
// Set the BarTender application visible
btApp.Visible = true;
// Open a BarTender document
btFormat = btApp.Formats.Open("c:\\Format1.btw", false, "");
// Set the object variable
btObject = btFormat.Objects.Find("Picture 1");
// Set the picture path
btObject.PicturePath = "c:\\MyPicture.jpg";
// End the BarTender process
btApp.Quit(BarTender.BtSaveOptions.btDoNotSaveChanges);