DeleteObject Method

The DeleteObject method can be used to delete an object from the PDF document.

 

Syntax

VB:

Sub DeleteObject(Object As String, CanUndo As Integer)

C#:

void DeleteObject(string Object, int CanUndo)

C++:

HRESULT DeleteObject(BSTR Object, long CanUndo)

 

Parameters

Object

An object name to delete.

CanUndo

This parameter should be set to True if the user is allowed to undo the delete object action. This is usually the case when this method is called from a menu or other user interface. This parameter should be set to False if the user cannot undo this action; this is more efficient and avoids the overhead related to managing the Undo list.

 

Example

Sub Sample()


    ' Constants for Activation codes


    Const strLicenseTo As String = "Amyuni PDF Creator Evaluation"


    Const strActivationCode As String = "07EFCDAB010001004282943F2AF19A88F332D9E781E40460727DF8A42847A1BDE06DB61C71E94E2D90424BF8762385335F9D6884E9FC"


 


    ' Initializing PDFCreativeX Object


    Dim pdf As ACPDFCREACTIVEX.PDFCreactiveX = New ACPDFCREACTIVEX.PDFCreactiveX()


 


    ' Set license key


    pdf.SetLicenseKey(strLicenseTo, strActivationCode)


 


    ' Set CurrentPage


    pdf.CurrentPage = 1


 


    ' Create a Text in the current Page


    pdf.CreateObject(ACPDFCREACTIVEX.ObjectTypeConstants.acObjectTypeText, "Text1")


 


    ' Define Object


    Dim oText As ACPDFCREACTIVEX.IacObject = pdf.GetObjectByName("Text1")


    oText("Left") = 1000


    oText("Right") = 5000


    oText("Top") = 0


    oText("Bottom") = 4000


    oText("BorderColor") = &HFF00FF


    oText("BorderWidth") = ACPDFCREACTIVEX.acBorderWidth.acBorderWidthDouble


    oText("Text") = "Amyuni Technologies"


 


    ' Create a Barcode in the current Page


    pdf.CreateObject(ACPDFCREACTIVEX.ObjectTypeConstants.acObjectTypeBarcode, "Barcode1")


    Dim oBarCode As ACPDFCREACTIVEX.IacObject = pdf.GetObjectByName("Barcode1")


    oBarCode("Left") = 100


    oBarCode("Right") = 3100


    oBarCode("Top") = 1000


    oBarCode("Bottom") = 2100


    oBarCode("BarcodeType") = 1  ' PDF417 barcodes are the only type supported


    oBarCode("VerticalScale") = 3.0  ' Amount by which To scale the barcode vertically, Default


    oBarCode("Text") = "Copyright 2015 Amyuni Technologies"


 


    ' Delete object Text1 without undo


    pdf.DeleteObject("Text1", 0)


 


    ' Save PDF


    pdf.Save("c:\temp\CreatePDFDocument_resulting.pdf", ACPDFCREACTIVEX.FileSaveOptionConstants.acFileSaveView)


 


    oText = Nothing


    oBarCode = Nothing


End Sub


static void Sample()


{


    // Constants for Activation codes


    const string strLicenseTo = "Amyuni PDF Creator Evaluation";


    const string strActivationCode = "07EFCDAB010001004282943F2AF19A88F332D9E781E40460727DF8A42847A1BDE06DB61C71E94E2D90424BF8762385335F9D6884E9FC";


 


    // Initializing PDFCreativeX Object


    ACPDFCREACTIVEX.PDFCreactiveX pdf = new ACPDFCREACTIVEX.PDFCreactiveX();


 


    // Set license key


    pdf.SetLicenseKey(strLicenseTo, strActivationCode);


 


    // Set CurrentPage


    pdf.CurrentPage = 1;


 


    // Create a Text in the current Page


    pdf.CreateObject(ACPDFCREACTIVEX.ObjectTypeConstants.acObjectTypeText, "Text1");


    ACPDFCREACTIVEX.IacObject oText = pdf.GetObjectByName("Text1".ToString());


    oText["Left"] = 1000;


    oText["Right"] = 5000;


    oText["Top"] = 0;


    oText["Bottom"] = 4000;


    oText["BorderColor"] = 0xFF00FF;


    oText["BorderWidth"] = ACPDFCREACTIVEX.acBorderWidth.acBorderWidthDouble;


    oText["Text"] = "Amyuni Technologies";


 


    // Create a Barcode in the current Page


    pdf.CreateObject(ACPDFCREACTIVEX.ObjectTypeConstants.acObjectTypeBarcode, "Barcode1");


    ACPDFCREACTIVEX.IacObject oBarCode = pdf.GetObjectByName("Barcode1".ToString());


    oBarCode["Left"] = 100;


    oBarCode["Right"] = 3100;


    oBarCode["Top"] = 1000;


    oBarCode["Bottom"] = 2100;        


    oBarCode["BarcodeType"] = 1;  // PDF417 barcodes are the only type supported


    oBarCode["VerticalScale"] = 3.0;  // Amount by which to scale the barcode vertically, default


    oBarCode["Text"] = "Copyright 2015 Amyuni Technologies";


 


    // Delete object Text1 without undo


    pdf.DeleteObject("Text1", 0);


 


    // Save PDF


    pdf.Save(@"c:\temp\CreatePDFDocument_resulting.pdf", ACPDFCREACTIVEX.FileSaveOptionConstants.acFileSaveView);


 


 


    oText = null;


    oBarCode = null;


}


#import "c:\users\amyuni\pdfcreactivex.dll" no_namespace


 


using namespace std;


 


int main()


{


    // Constants for Activation codes


    bstr_t strLicenseTo = "Amyuni PDF Creator Evaluation";


    bstr_t strActivationCode = "07EFCDAB010001004282943F2AF19A88F332D9E781E40460727DF8A42847A1BDE06DB61C71E94E2D90424BF8762385335F9D6884E9FC";


 


    // Initialize the COM subsystem


    CoInitialize(0);


 


    // IPDFCreactiveXPtr is a smart pointer type defined in pdfcreactivex.tlh,


    // the type library header file generated by the #import instruction above


    IPDFCreactiveXPtr pdf;


 


    // Create the PDFCreactiveX instance


    pdf.CreateInstance(__uuidof(PDFCreactiveX));


 


    // set license key


    pdf->SetLicenseKey(_bstr_t(strLicenseTo), _bstr_t(strActivationCode));


 


    // Set CurrentPage


    pdf->CurrentPage = 1;


 


    // Set-up variables for attributes


    _variant_t varAttribute;


    varAttribute.vt = VT_I4;  // integers


 


    // Create a text in the current Page


    pdf->CreateObject(acObjectTypeText, "Text1");


    IacObjectPtr oText = pdf->GetObjectByName("Text1");


    oText->Attribute["Left"] = 1000;


    oText->Attribute["Right"] = 5000;


    oText->Attribute["Top"] = 0;


    oText->Attribute["Bottom"] = 4000;


    varAttribute.lVal = 0xFF00FF;


    oText->Attribute["BorderColor"] = varAttribute;


    varAttribute.lVal = acBorderWidthDouble;


    oText->Attribute["BorderWidth"] = varAttribute;


    oText->Attribute["Text"] = "Amyuni Technologies";


 


    // Create a Barcode in the current Page


    pdf->CreateObject(acObjectTypeBarcode, "Barcode1");


    IacObjectPtr oBarcode = pdf->GetObjectByName("Barcode1");


    oBarcode->Attribute["Left"] = 100;


    oBarcode->Attribute["Right"] = 3100;


    oBarcode->Attribute["Top"] = 1000;


    oBarcode->Attribute["Bottom"] = 2100;


    varAttribute.lVal = 1;


    oBarcode->Attribute["BarcodeType"] = varAttribute;  // PDF417 barcodes are the only type supported


    oBarcode->Attribute["VerticalScale"] = 3.0;  // Amount by which to scale the barcode vertically, default


    oBarcode->Attribute["Text"] = "Copyright 2015 Amyuni Technologies";


 


    // Delete object Text1 without undo


    pdf->DeleteObject("Text1", 0);


 


    // Save PDF


    pdf->Save("c:\\temp\\CreatePDFDocument_resulting.pdf", acFileSaveView);


 


    // destroy objects


    pdf = NULL;


    oText = NULL;


    oBarcode = NULL;


 


    return 0;


}


' ObjectTypeConstants


Const acObjectTypeArrow = 36


Const acObjectTypeBarcode = 45


Const acObjectTypeCell = 33


Const acObjectTypeCheckBox = 21


Const acObjectTypeEllipse = 4


Const acObjectTypeExcel = 17


Const acObjectTypeField = 6


Const acObjectTypeGraph = 19


Const acObjectTypeHighlight = 23


Const acObjectTypeLine = 1


Const acObjectTypePicture = 7


Const acObjectTypePolygon = 8


Const acObjectTypeRoundFrame = 3


Const acObjectTypeRow = 32


Const acObjectTypeSelection = 24


Const acObjectTypeSignature = 39


Const acObjectTypeStickyNote = 22


Const acObjectTypeTable = 16


Const acObjectTypeText = 5


 


' acBorderWidth


Const acBorderWidthNone = 0


Const acBorderWidthSimple = 1


Const acBorderWidthDouble = 2


Const acBorderWidthTriple = 3


Const acBorderWidthQuadruple = 4


 


' FileSaveOptionConstants


Const acFileSaveAll = 0


Const acFileSaveDefault = -1


Const acFileSaveView = 1


Const acFileSaveDesign = 2


Const acFileSavePDFA_7 = 3


Const acFileSavePDFA = 4


Const acFileSavePDF14 = 5


 


' Constants for Activation codes


Const strLicenseTo = "Amyuni PDF Creator Evaluation"


Const strActivationCode = "07EFCDAB010001004282943F2AF19A88F332D9E781E40460727DF8A42847A1BDE06DB61C71E94E2D90424BF8762385335F9D6884E9FC"


 


' Initializing PDFCreativeX Object


Dim pdf


Set pdf = CreateObject("PDFCreactiveX.PDFCreactiveX.6.5")


 


' Set license key


pdf.SetLicenseKey strLicenseTo, strActivationCode


 


' Set CurrentPage


pdf.CurrentPage = 1


 


' Create a Text in the current Page


pdf.CreateObject acObjectTypeText, "Text1"


Dim oText 


Set oText = pdf.GetObjectByName("Text1")


oText("Left") = 1000


oText("Right") = 5000


oText("Top") = 0


oText("Bottom") = 4000


oText("BorderColor") = &HFF00FF


oText("BorderWidth") = acBorderWidthDouble


oText("Text") = "Amyuni Technologies"


 


' Create a Barcode in the current Page


pdf.CreateObject acObjectTypeBarcode, "Barcode1"


Dim oBarCode


Set oBarCode= pdf.GetObjectByName("Barcode1")


oBarCode("Left") = 100


oBarCode("Right") = 3100


oBarCode("Top") = 1000


oBarCode("Bottom") = 2100


oBarCode("BarcodeType") = 1  ' PDF417 barcodes are the only type supported


oBarCode("VerticalScale") = 3.0  ' Amount by which To scale the barcode vertically, Default


oBarCode("Text") = "Copyright 2015 Amyuni Technologies"


 


' Delete object Text1 without undo


pdf.DeleteObject "Text1", 0


 


' Save PDF


pdf.Save "c:\temp\CreatePDFDocument_resulting.pdf", acFileSaveView


 


' destroy Objects


Set pdf = Nothing


Set oText = Nothing


Set oBarCode = Nothing